-
-
Notifications
You must be signed in to change notification settings - Fork 31.8k
GH-124478: Cleanup argparse documentation #124877
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.
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
Conversation
Co-authored-by: Jelle Zijlstra <[email protected]>
I looked at the preview https://cpython-previews--124877.org.readthedocs.build/en/124877/library/argparse.html#module-argparse and skimmed the entire doc. Below are some things I noticed. None are new to this PR, so feel free to ignore them and I can file a separate PR with those cleanups.
|
Thanks so much for such a thorough review, @JelleZijlstra. I think I can incorporate your feedback in this PR. I'll revisit this tomorrow evening. |
Co-authored-by: Tomas R <[email protected]>
Co-authored-by: Tomas R <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Lovely work @savannahostrowski. Thank you!
@JelleZijlstra, I applied all of your suggestions. I also found formatting inconsistencies in taking another pass related to indentation and style. |
Thanks @savannahostrowski for the PR, and @JelleZijlstra for merging it 🌮🎉.. I'm working now to backport this PR to: 3.12, 3.13. |
Sorry, @savannahostrowski and @JelleZijlstra, I could not cleanly backport this to
|
Sorry, @savannahostrowski and @JelleZijlstra, I could not cleanly backport this to
|
GH-125162 is a backport of this pull request to the 3.13 branch. |
(cherry picked from commit 37228bd) Co-authored-by: Savannah Ostrowski <[email protected]> Co-authored-by: Jelle Zijlstra <[email protected]> Co-authored-by: Tomas R <[email protected]>
GH-125164 is a backport of this pull request to the 3.12 branch. |
(cherry picked from commit 37228bd) Co-authored-by: Jelle Zijlstra <[email protected]> Co-authored-by: Tomas R <[email protected]>
(cherry picked from commit 37228bd) Co-authored-by: Jelle Zijlstra <[email protected]> Co-authored-by: Tomas R <[email protected]>
Co-authored-by: Jelle Zijlstra <[email protected]> Co-authored-by: Tomas R <[email protected]>
This PR:
ArgumentParser
andadd_argument
much higher up the page. I don't think this is terribly necessary anymore.Please let me know if there are other best practices we consistently use in other documentation areas but lack here. I'm happy to incorporate them here so we can get these documents feeling fresh!
(As a note, I tried to be somewhat conservative here as I do think many of the examples are 1) valuable for new users and 2) too advanced to add to the tutorial in its current form)