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

Incorrect information in add_subparser() docs. #95377

Open
JCrane512 opened this issue Jul 28, 2022 · 1 comment
Open

Incorrect information in add_subparser() docs. #95377

JCrane512 opened this issue Jul 28, 2022 · 1 comment
Labels
docs Documentation in the Doc dir

Comments

@JCrane512
Copy link

JCrane512 commented Jul 28, 2022 •
edited by bedevere-bot

Documentation

When setting the flag required=true for the function ArgumentParser.add_subparsers() the setting dest=" some description" also needs to be set or the parser throws an unhelpful error when the user fails to select a subparser.

This is not covered in the documentation.

Linked PRs
@JCrane512 JCrane512 added the docs Documentation in the Doc dir label Jul 28, 2022
@MonadChains
Copy link
Contributor

I agree. The documentation is not fully clear, and adding a line to clarify it could be beneficial, especially given the complexity of the module.

@PurityLake PurityLake mentioned this issue Jul 31, 2022
Closed
PurityLake added a commit to PurityLake/cpython that referenced this issue Jul 31, 2022
@PurityLake
pythongh-95377: Editted docs for argparse
e9f7a26
PurityLake added a commit to PurityLake/cpython that referenced this issue Aug 5, 2022
@PurityLake
pythongh-95377: Editted docs for argparse
ce36799
PurityLake added a commit to PurityLake/cpython that referenced this issue Dec 24, 2022
@PurityLake
pythongh-95377: Removed unnessecary line in argpase.rst
1892cfe
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docs Documentation in the Doc dir
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@JCrane512 @MonadChains