Repository navigation
Move the Argument Clinic docs to the devguide #107518
Description
See topic on Discourse and python/devguide#1148
Quoting from the linked topic:
Currently, the Argument Clinic docs live in the How-To section of docs.python.org:
https://docs.python.org/3/howto/clinic.html.
The devguide does not mention Argument Clinic at all (except in the experts section).
The clinic docs's primary audience are core developers and contributors, which is also the primary audience of the devguide. I'd like to suggest we move the clinic docs from docs.python.org to devguide.python.org.
So far, I've only received encouraging reactions, both on Discourse and on the core dev Discord.
TODO:
- Filter out Doc/howto/clinic.rst
- Add the filtered out branch to the devguide: Move Argument Clinic's documentation to the Developer's Guide devguide#1160
- Replace the clinic.rst contents with a link to the devguide and a short text about why the change was made
Activity
erlend-aasland commentedon Aug 2, 2023
Filtered out branch: https://github.com/erlend-aasland/devguide/tree/migrate-clinic-docs
PR:
erlend-aasland commentedon Sep 26, 2023
Thanks to @AA-Turner, python/devguide#1160 has now landed!
AA-Turner commentedon Sep 26, 2023
And now rendered!
A
erlend-aasland commentedon Sep 26, 2023
Wow, that was fast :) Next, we need to redirect the old docs to the devguide (if possible!).
rhettinger commentedon Oct 1, 2023
+1 for moving to the devguide.
GH-107518: Remove the Argument Clinic How-To (#109900)
[3.12] pythonGH-107518: Remove the Argument Clinic How-To (python#109900
erlend-aasland commentedon Oct 12, 2023
Backports to 3.12 and 3.11 are queued for automerging. Marking this as resolved. Thanks to everyone who has helped with this effort; highly appreciated.
[3.12] GH-107518: Remove the Argument Clinic How-To (#109900) (#110760)
[3.11] GH-107518: Remove the Argument Clinic How-To (#109900) (#110761)
pythonGH-107518: Remove the Argument Clinic How-To (python#109900)