Skip to content

gh-95377: Editted docs for argparse.add_subparser #95490

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

Closed
PurityLake wants to merge 6 commits into from
Closed

gh-95377: Editted docs for argparse.add_subparser #95490

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
ce36799
gh-95377: Editted docs for argparse
PurityLake Jul 31, 2022
2de027d
Merge branch 'python:main' into add-docs-95377
PurityLake Aug 27, 2022
e691341
Merge branch 'python:main' into add-docs-95377
PurityLake Dec 24, 2022
1892cfe
gh-95377: Removed unnessecary line in argpase.rst
PurityLake Dec 24, 2022
3f4f230
Merge branch 'main' into add-docs-95377
PurityLake Jan 20, 2023
c0cc077
Merge branch 'main' into add-docs-95377
PurityLake May 23, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions Doc/library/argparse.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1745,10 +1745,12 @@ Sub-commands
encountered at the command line

* dest_ - name of the attribute under which sub-command name will be
stored; by default ``None`` and no value is stored
stored; by default ``None`` and no value is stored. Required if
required_ has been passed

@iritkatriel iritkatriel Aug 14, 2022

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

‘Required if required’ doesn’t read well.

maybe just remove this addition. Is it not enough to document this under ‘required’?

@PurityLake PurityLake Dec 24, 2022

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Apologies for the radio silence, I have removed the line as requested, as yes it isn't needed


* required_ - Whether or not a subcommand must be provided, by default
``False`` (added in 3.7)
``False``. If this option parameter is passed then it is required
to also pass in dest_ (added in 3.7)

* help_ - help for sub-parser group in help output, by default ``None``

Expand Down
2 changes: 2 additions & 0 deletions Misc/NEWS.d/next/Documentation/2022-07-31-03-03-14.gh-issue-95377.3ztj8F.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Added two lines to :func:`argparse.add_subparsers`, to tell user to always
add the dest parameter if the required parameter is passed