Skip to content
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

Review and simplify argparse docs #124478

Closed
savannahostrowski opened this issue Sep 25, 2024 · 2 comments
Closed

Review and simplify argparse docs #124478

savannahostrowski opened this issue Sep 25, 2024 · 2 comments
Assignees
@savannahostrowski
Labels
docs Documentation in the Doc dir

Comments

@savannahostrowski
Copy link
Member

savannahostrowski commented Sep 25, 2024 •
edited by bedevere-app bot
Loading

The argparse docs have become pretty lengthy. This is in part due to the examples, which are somewhat duplicative of the tutorial. I'd like to go through the docs to see if we can dedupe and pare things down to make them more readable.

Linked PRs
@savannahostrowski savannahostrowski added the docs Documentation in the Doc dir label Sep 25, 2024
@savannahostrowski savannahostrowski self-assigned this Sep 25, 2024
@rruuaanng
Copy link
Contributor

rruuaanng commented Sep 26, 2024 •
edited
Loading

I believe that argparse does not need to display sample code, only the public API needs to be shown.

@hugovk
Copy link
Member

hugovk commented Sep 26, 2024 •
edited
Loading

I disagree, argparse is part of the public API and sample code is useful to show how to use it.

@bedevere-app bedevere-app bot mentioned this issue Oct 2, 2024
Merged
savannahostrowski added a commit to savannahostrowski/cpython that referenced this issue Oct 3, 2024
@savannahostrowski
Merge branch 'main' into pythongh-124478
743bfb5
savannahostrowski added a commit to savannahostrowski/cpython that referenced this issue Oct 7, 2024
@savannahostrowski
Merge branch 'main' into pythongh-124478
d9f261c
savannahostrowski added a commit to savannahostrowski/cpython that referenced this issue Oct 8, 2024
@savannahostrowski
Merge branch 'main' into pythongh-124478
8fcdb3a
JelleZijlstra added a commit that referenced this issue Oct 8, 2024
@savannahostrowski @JelleZijlstra @tomasr8
GH-124478: Cleanup argparse documentation (#124877)
37228bd 
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
Co-authored-by: Tomas R <tomas.roun8@gmail.com>
@bedevere-app bedevere-app bot mentioned this issue Oct 8, 2024
Merged
savannahostrowski added a commit to savannahostrowski/cpython that referenced this issue Oct 8, 2024
@savannahostrowski @JelleZijlstra @tomasr8
[3.13] pythonGH-124478: Cleanup argparse documentation (pythonGH-124877)
6ba27ae 
(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>
@bedevere-app bedevere-app bot mentioned this issue Oct 8, 2024
Merged
JelleZijlstra added a commit that referenced this issue Oct 8, 2024
@savannahostrowski @JelleZijlstra @tomasr8
[3.13] GH-124478: Cleanup argparse documentation (GH-124877) (#125162)
5f2a5ac 
(cherry picked from commit 37228bd)

Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
Co-authored-by: Tomas R <tomas.roun8@gmail.com>
JelleZijlstra added a commit that referenced this issue Oct 8, 2024
@savannahostrowski @JelleZijlstra @tomasr8
[3.12] GH-124478: Cleanup argparse documentation (GH-124877) (#125164)
0dbad1d 
(cherry picked from commit 37228bd)

Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
Co-authored-by: Tomas R <tomas.roun8@gmail.com>
efimov-mikhail pushed a commit to efimov-mikhail/cpython that referenced this issue Oct 9, 2024
@savannahostrowski @JelleZijlstra
@tomasr8 @efimov-mikhail
pythonGH-124478: Cleanup argparse documentation (python#124877)
0dcbd9b 
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
Co-authored-by: Tomas R <tomas.roun8@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@savannahostrowski savannahostrowski

Labels
docs Documentation in the Doc dir
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@hugovk @savannahostrowski @rruuaanng