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

gh-93217: fix some issues in man page and --help #93219

Merged
merged 4 commits into from
May 26, 2022
Merged

gh-93217: fix some issues in man page and --help #93219

merged 4 commits into from
May 26, 2022

Conversation

merwok
Copy link
Member

@merwok merwok commented May 25, 2022

No description provided.

@merwok merwok added 🔨 test-with-buildbots Test PR w/ buildbots; report in status section needs backport to 3.10 only security fixes needs backport to 3.11 only security fixes labels May 25, 2022
@merwok merwok self-assigned this May 25, 2022
@bedevere-bot
Copy link

🤖 New build scheduled with the buildbot fleet by @merwok for commit 24526bd 🤖

If you want to schedule another build, you need to add the ":hammer: test-with-buildbots" label again.

@bedevere-bot bedevere-bot added awaiting core review and removed 🔨 test-with-buildbots Test PR w/ buildbots; report in status section labels May 25, 2022
@merwok merwok linked an issue May 25, 2022 that may be closed by this pull request
Minor issues in python --help and man page #93217
Closed
@merwok merwok mentioned this pull request May 25, 2022
Closed
@merwok merwok closed this May 25, 2022
@merwok merwok reopened this May 25, 2022
ericsnowcurrently
ericsnowcurrently approved these changes May 25, 2022
View reviewed changes
Copy link
Member

@ericsnowcurrently ericsnowcurrently left a comment

Choose a reason for hiding this comment

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

LGTM

You may want to get a second opinion about --check-hash-based-pycs though.

Python/initconfig.c Outdated
Comment on lines 104 to 105
--check-hash-based-pycs always|default|never:\n\
control how Python invalidates hash-based .pyc files\n\
Copy link
Member

Choose a reason for hiding this comment

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

I'm guessing this was kept separate because it is a long arg. I don't have much opinion on whether it should be kept separate or not. 🙂

Copy link
Member Author

@merwok merwok May 25, 2022 •
edited
Loading

Choose a reason for hiding this comment

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

I don’t mind it staying at the end (edit: but not after -X options), but then I would move the item in the man page to match!

Copy link
Member

Choose a reason for hiding this comment

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

Whatever works. :)

Copy link
Member Author

Choose a reason for hiding this comment

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

I like the long options at the end of --help output, especially after the other PR that adds --help-env, --help-xoptions and --help-all). I am also not reordering the man page: long options are on the last line of the synopsis, and in alphabetical order in the full doc, both of which are good.

merwok
merwok commented May 26, 2022
View reviewed changes
Python/initconfig.c Outdated Show resolved Hide resolved
merwok
merwok commented May 26, 2022
View reviewed changes
Python/initconfig.c Outdated Show resolved Hide resolved
@merwok merwok merged commit da39719 into python:main May 26, 2022
@merwok merwok deleted the fix-help-man branch May 26, 2022 14:31
@miss-islington
Copy link
Contributor

Thanks @merwok for the PR 🌮🎉.. I'm working now to backport this PR to: 3.10, 3.11.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request May 26, 2022
@merwok @miss-islington
pythongh-93217: fix some issues in man page and --help (pythonGH-93219)
f706d94 
(cherry picked from commit da39719)

Co-authored-by: Éric <merwok@netwok.org>
@miss-islington
Copy link
Contributor

Sorry, @merwok, I could not cleanly backport this to 3.10 due to a conflict.
Please backport using cherry_picker on command line.
cherry_picker da397194832c4b8db8446af42919d8ad47b3cb4a 3.10

@bedevere-bot bedevere-bot removed the needs backport to 3.11 only security fixes label May 26, 2022
@bedevere-bot
Copy link

GH-93260 is a backport of this pull request to the 3.11 branch.

miss-islington added a commit that referenced this pull request May 26, 2022
@miss-islington @merwok
gh-93217: fix some issues in man page and --help (GH-93219)
33336e4 
(cherry picked from commit da39719)

Co-authored-by: Éric <merwok@netwok.org>
@bedevere-bot bedevere-bot removed the needs backport to 3.10 only security fixes label May 26, 2022
@bedevere-bot
Copy link

GH-93261 is a backport of this pull request to the 3.10 branch.

merwok added a commit to merwok/cpython that referenced this pull request May 26, 2022
@merwok
[3.10] pythongh-93217: fix some issues in man page and --help (python…
49ff903 
…GH-93219).

(cherry picked from commit da39719)

Co-authored-by: Éric <merwok@netwok.org>
@ericsnowcurrently
Copy link
Member

Thanks for doing this, @merwok!

merwok added a commit that referenced this pull request May 29, 2022
@merwok
[3.10] gh-93217: fix some issues in man page and --help (GH-93219) (#…
c649526 
…93261)
@merwok merwok mentioned this pull request Apr 17, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@pablogsal pablogsal Awaiting requested review from pablogsal

@serhiy-storchaka serhiy-storchaka Awaiting requested review from serhiy-storchaka

@ericsnowcurrently ericsnowcurrently Awaiting requested review from ericsnowcurrently ericsnowcurrently is a code owner

Assignees

@merwok merwok

Labels
skip news
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Minor issues in python --help and man page
5 participants
@merwok @bedevere-bot @miss-islington @ericsnowcurrently @serhiy-storchaka