Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork33.7k
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Uh oh!
There was an error while loading.Please reload this page.
Conversation
Uh oh!
There was an error while loading.Please reload this page.
Uh oh!
There was an error while loading.Please reload this page.
Uh oh!
There was an error while loading.Please reload this page.
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
Uh oh!
There was an error while loading.Please reload this page.
Uh oh!
There was an error while loading.Please reload this page.
Uh oh!
There was an error while loading.Please reload this page.
Uh oh!
There was an error while loading.Please reload this page.
JelleZijlstra commentedOct 2, 2024
I looked at the previewhttps://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.
|
savannahostrowski commentedOct 2, 2024
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. |
Uh oh!
There was an error while loading.Please reload this page.
Uh oh!
There was an error while loading.Please reload this page.
Co-authored-by: Tomas R <tomas.roun8@gmail.com>
Co-authored-by: Tomas R <tomas.roun8@gmail.com>
willingc left a comment
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!
savannahostrowski commentedOct 3, 2024
@JelleZijlstra, I applied all of your suggestions. I also found formatting inconsistencies in taking another pass related to indentation and style. |
Uh oh!
There was an error while loading.Please reload this page.
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 the3.13 branch. |
(cherry picked from commit37228bd)Co-authored-by: Savannah Ostrowski <savannahostrowski@gmail.com>Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>Co-authored-by: Tomas R <tomas.roun8@gmail.com>
GH-125164 is a backport of this pull request to the3.12 branch. |
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>Co-authored-by: Tomas R <tomas.roun8@gmail.com>
Uh oh!
There was an error while loading.Please reload this page.
This PR:
ArgumentParserandadd_argumentmuch 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)