Skip to content

gh-94787: [doc] Add to argparse doc an example of a mutually-exclusive group nested in an argument group #94807

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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Sep 18, 2022

Conversation

scottamain
Copy link
Contributor

@scottamain scottamain commented Jul 13, 2022

It's not obvious that a group can be added to a group, and this is important when trying to organize your help output.

(New main branch PR originally from PR #94788)

It's not obvious that a group can be added to a group, and this is important when trying to organize your help output.

(New main branch PR originally from PR python#94788)
@bedevere-bot
Copy link

Most changes to Python require a NEWS entry.

Please add it using the blurb_it web app or the blurb command-line tool.

@scottamain
Copy link
Contributor Author

Friendly nudge. @slateny

@slateny
Copy link
Contributor

slateny commented Sep 13, 2022

Actually, per #66246 some forms of nesting may not actually be supported, and there's also a deprecation note underneath the changes mentioning that nesting with mutually exclusive group is deprecated.

@scottamain
Copy link
Contributor Author

Okay, but this change is about adding a mutex group to a regular arg group (to get help title/description), not to another mutex group, which I believe is what all those other conversations are about. So I've just updated the PR with some copy changes to clarify that. Is it okay in this manner?

Copy link
Contributor

@slateny slateny left a comment

Choose a reason for hiding this comment

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

Since Irit said it's supported, the clarifications lgtm :)

scottamain and others added 3 commits September 14, 2022 09:33
Co-authored-by: Stanley <[email protected]>
Copy link
Contributor

@slateny slateny left a comment

Choose a reason for hiding this comment

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

lgtm thanks, will tag Irit per the reply in the issue

Co-authored-by: Irit Katriel <[email protected]>
@iritkatriel iritkatriel changed the title gh-94787: Add tip to put mutually-exclusive group into help group gh-94787: [doc] Add to argparse doc an example of a mutually-exclusive group nested in an argument group Sep 18, 2022
@iritkatriel iritkatriel merged commit 810ae51 into python:main Sep 18, 2022
@iritkatriel
Copy link
Member

Thank you, @scottamain.

@scottamain
Copy link
Contributor Author

My pleasure, thank you for your prompt attention and contribution, @iritkatriel and @slateny

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir skip news
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants