X Tutup
The Wayback Machine - https://web.archive.org/web/20250701050116/https://github.com/python/cpython/pull/26279
Skip to content

bpo-11176: give more meaningful argument names in argparse documentation #26279

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
Closed
wants to merge 3 commits into from
Closed

bpo-11176: give more meaningful argument names in argparse documentation #26279

wants to merge 3 commits into from

Conversation

Bonifacio2
Copy link
Contributor

@Bonifacio2 Bonifacio2 commented May 21, 2021 •
edited by bedevere-bot
Loading

@bedevere-bot bedevere-bot added awaiting review docs Documentation in the Doc dir labels May 21, 2021
nanjekyejoannah
nanjekyejoannah reviewed May 27, 2021
View reviewed changes
Copy link
Contributor

@nanjekyejoannah nanjekyejoannah left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Can you give the original authors some credit too on the PR, if you built on their work, please?

We usually do it by putting co-author: <author email> in the PR comment.

@Bonifacio2
Copy link
Contributor Author

Hello, @nanjekyejoannah. I only downloaded and tried to apply the original patch. I didn't look into its content (partially because I was afraid I would be influenced by what they had done and unable to give proper attribution).

@github-actions
Copy link

github-actions bot commented Jul 8, 2021

This PR is stale because it has been open for 30 days with no activity.

@github-actions github-actions bot added the stale Stale PR or inactive for long period of time. label Jul 8, 2021
MaxwellDupre
MaxwellDupre approved these changes Mar 24, 2022
View reviewed changes
Copy link
Contributor

@MaxwellDupre MaxwellDupre left a comment

Choose a reason for hiding this comment

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

The new stuff looks ok.

@rhettinger
Copy link
Contributor

I prefer the current form. We have an introductory section and tutorial with well motivated use cases. For the details docs the emphasis shifts to the mechanics of the operation, so the foo and bar style work better.

Thanks for the suggestion, but I think we should pass on this one. It changes the style of the docs in a way that I think makes the less useful as a reference.

@rhettinger rhettinger closed this May 10, 2022
@bethard bethard mannequin mentioned this pull request Apr 10, 2022
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@MaxwellDupre MaxwellDupre MaxwellDupre approved these changes

@nanjekyejoannah nanjekyejoannah Awaiting requested review from nanjekyejoannah

Assignees
No one assigned
Labels
awaiting review docs Documentation in the Doc dir stale Stale PR or inactive for long period of time.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@Bonifacio2 @rhettinger @MaxwellDupre @nanjekyejoannah @the-knights-who-say-ni @bedevere-bot
X Tutup