Skip to content

gh-65169: Clarify prog behavior in argparse - #31602

Merged
serhiy-storchaka merged 2 commits into
python:mainfrom
slateny:s/argparse
Sep 24, 2024
Merged

gh-65169: Clarify prog behavior in argparse#31602
serhiy-storchaka merged 2 commits into
python:mainfrom
slateny:s/argparse

Conversation

@slateny

@slateny slateny commented Feb 27, 2022

Copy link
Copy Markdown
Contributor

For the latter part of the PR, my understanding is that we have this originally:

... match how the program was invoked on the command line

which implies that if the program is called like

./some-dir/run.py

then the help message will match it, but that's inaccurate. And while symlinks were mentioned in the bpo I'm not too sure how the original would read wrong, but nonetheless the suggested rewording fits well to me so I've used it with some very minor changes.

Co-authored-by: Kinga Farkas

https://bugs.python.org/issue20970

@bedevere-bot bedevere-bot added the docs Documentation in the Doc dir label Feb 27, 2022
@slateny slateny changed the title bpo-20970: Clarified prog behavior in argparse bpo-20970: Clarify prog behavior in argparse Mar 4, 2022

@DanielNoord DanielNoord left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

We should probably add the co-author in the commit message so they actually get credited for it.

Also, we can now link to the github issue so it gets closed when this gets merged.

@slateny

slateny commented Jul 20, 2022

Copy link
Copy Markdown
Contributor Author

I believe that on merge, Github will automatically pull the co-author from the description so no need to put it in the commit message. Good point on the gh issue, I'll change them over for convenience.

@slateny slateny changed the title bpo-20970: Clarify prog behavior in argparse gh-65169: Clarify prog behavior in argparse Jul 20, 2022
@mehrdadmoradii

Copy link
Copy Markdown
Contributor

@DanielNoord I have created a new PR #96983. I also mentioned both @slateny and @lilbludot on that.

@slateny

slateny commented Sep 21, 2022

Copy link
Copy Markdown
Contributor Author

What's the reason for making a new PR?

@slateny

slateny commented Oct 13, 2022

Copy link
Copy Markdown
Contributor Author

@asvetlov It looks like the section being updated here was written by you some 10 years ago, could you take a peek at it?

@savannahostrowski savannahostrowski left a comment

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.

It looks like this may have gotten lost in the fold but after reading through the issue thread, this looks good to me.

@serhiy-storchaka serhiy-storchaka added needs backport to 3.12 only security fixes needs backport to 3.13 bugs and security fixes labels Sep 24, 2024
@serhiy-storchaka
serhiy-storchaka enabled auto-merge (squash) September 24, 2024 10:34
@serhiy-storchaka
serhiy-storchaka merged commit e69ff34 into python:main Sep 24, 2024
@miss-islington-app

Copy link
Copy Markdown

Thanks @slateny for the PR, and @serhiy-storchaka for merging it 🌮🎉.. I'm working now to backport this PR to: 3.12, 3.13.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Sep 24, 2024
(cherry picked from commit e69ff34)

Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
@bedevere-app

bedevere-app Bot commented Sep 24, 2024

Copy link
Copy Markdown

GH-124430 is a backport of this pull request to the 3.13 branch.

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Sep 24, 2024
(cherry picked from commit e69ff34)

Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
@bedevere-app bedevere-app Bot removed the needs backport to 3.13 bugs and security fixes label Sep 24, 2024
@bedevere-app

bedevere-app Bot commented Sep 24, 2024

Copy link
Copy Markdown

GH-124431 is a backport of this pull request to the 3.12 branch.

@bedevere-app bedevere-app Bot removed the needs backport to 3.12 only security fixes label Sep 24, 2024
serhiy-storchaka pushed a commit that referenced this pull request Sep 24, 2024
(cherry picked from commit e69ff34)

Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
Yhg1s pushed a commit that referenced this pull request Sep 24, 2024
gh-65169: Clarify prog default in argparse (GH-31602)
(cherry picked from commit e69ff34)

Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
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.

9 participants