8000 Move the Argument Clinic docs to the devguide · Issue #107518 · python/cpython · GitHub
[go: up one dir, main page]
Skip to content

Move the Argument Clinic docs to the devguide #107518

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
3 tasks done
erlend-aasland opened this issue Jul 31, 2023 · 6 comments
Closed
3 tasks done

Move the Argument Clinic docs to the devguide #107518

erlend-aasland opened this issue Jul 31, 2023 · 6 comments
Labels
docs Documentation in the Doc dir topic-argument-clinic

Comments

@erlend-aasland
Copy link
Contributor
erlend-aasland commented Jul 31, 2023 •
edited by bedevere-app bot
Loading

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:

Linked PRs
@erlend-aasland erlend-aasland added docs Documentation in the Doc dir topic-argument-clinic labels Jul 31, 2023
@erlend-aasland erlend-aasland mentioned this issue Aug 2, 2023
Closed
3 tasks
@erlend-aasland
Copy link
Contributor Author
erlend-aasland commented Aug 2, 2023 •
edited
Loading

Filtered out branch: https://github.com/erlend-aasland/devguide/tree/migrate-clinic-docs

PR:

@erlend-aasland
Copy link
Contributor Author

Thanks to @AA-Turner, python/devguide#1160 has now landed!

@AA-Turner
Copy link
Member

And now rendered!

A

@erlend-aasland
Copy link
Contributor Author

And now rendered!

Wow, that was fast :) Next, we need to redirect the old docs to the devguide (if possible!).

@bedevere-app bedevere-app bot mentioned this issue Sep 26, 2023
Merged
@rhettinger
Copy link
Contributor

+1 for moving to the devguide.

erlend-aasland pushed a commit that referenced this issue Oct 11, 2023
@AA-Turner
GH-107518: Remove the Argument Clinic How-To (#109900)
d1f7fae 
* Remove the content of the Argument Clinic HOWTO
* Update cross-references to the Argument Clinic
* Add a note directing readers to the devguide
@bedevere-app bedevere-app bot mentioned this issue Oct 12, 2023
Merged
erlend-aasland pushed a commit to erlend-aasland/cpython that referenced this issue Oct 12, 2023
@AA-Turner @erlend-aasland
[3.12] pythonGH-107518: Rem 8000 ove the Argument Clinic How-To (python#109900
af63736 
)

(cherry picked from commit d1f7fae)

* Remove the content of the Argument Clinic HOWTO
* Update cross-references to the Argument Clinic
* Add a note directing readers to the devguide
@bedevere-app bedevere-app bot mentioned this issue Oct 12, 2023
Merged
@erlend-aasland
Copy link
Contributor Author

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.

erlend-aasland added a commit that referenced this issue Oct 12, 2023
@erlend-aasland @AA-Turner
[3.12] GH-107518: Remove the Argument Clinic How-To (#109900) (#110760)
e8d0419 
(cherry picked from commit d1f7fae)

* Remove the content of the Argument Clinic HOWTO
* Update cross-references to the Argument Clinic
* Add a note directing readers to the devguide

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
erlend-aasland added a commit that referenced this issue Oct 12, 2023
@erlend-aasland @AA-Turner
[3.11] GH-107518: Remove the Argument Clinic How-To (#109900) (#110761)
5178fb0 
(cherry picked from commit d1f7fae)

* Remove the content of the Argument Clinic HOWTO
* Update cross-references to the Argument Clinic
* Add a note directing readers to the devguide

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Glyphack pushed a commit to Glyphack/cpython that referenced this issue Sep 2, 2024
@AA-Turner @Glyphack
pythonGH-107518: Remove the Argument Clinic How-To (python#109900)
170c0de 
* Remove the content of the Argument Clinic HOWTO
* Update cross-references to the Argument Clinic
* Add a note directing readers to the devguide
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docs Documentation in the Doc dir topic-argument-clinic
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@rhettinger @AA-Turner @erlend-aasland
0