Uh oh!
There was an error while loading. Please reload this page.
GH-124478: Cleanup argparse documentation - #124877
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
commented
Oct 2, 2024
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.
|
savannahostrowski
commented
Oct 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.
Lovely work @savannahostrowski. Thank you!
savannahostrowski
commented
Oct 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 the 3.13 branch. |
(cherry picked from commit 37228bd) 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 the 3.12 branch. |
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com> Co-authored-by: Tomas R <tomas.roun8@gmail.com>
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)