Skip to content

bpo-39427: Document -X opt options in the CLI --help and the man page #18131

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 3 commits into from
Jan 23, 2020

Conversation

pablogsal
Copy link
Member

@pablogsal pablogsal commented Jan 22, 2020

@pablogsal pablogsal changed the title bpo-39427: Document -X opt options in the CLI --help bpo-39427: Document -X opt options in the CLI --help and the man page Jan 22, 2020
@pablogsal pablogsal self-assigned this Jan 22, 2020
checks which are too expensive to be enabled by default. It will not be
more verbose than the default if the code is correct: new warnings are
only emitted when an issue is detected. Effect of the developer mode:
* Add default warning filter, as -W default
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 not sure if the manual page should elaborate on what are the effects of the development mode. It evolved frequently, and sadly it's common to forget to update the manual page.

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'm not sure if the manual page should elaborate on what are the effects of the development mode. It evolved frequently, and sadly it's common to forget to update the manual page.

I still think is a good idea to have it in the man page but if you feel strongly I can remove it :)

@DinoV
Copy link
Contributor

DinoV commented Jan 23, 2020

I was just looking at the help to figure out what these were and had to go look at source code, so i think this looks great. I do wonder if there should eventually be two levels of help but this seems on par w/ having the env vars documented in help.

@miss-islington
Copy link
Contributor

Thanks @pablogsal for the PR 🌮🎉.. I'm working now to backport this PR to: 3.7, 3.8.
🐍🍒⛏🤖

@miss-islington
Copy link
Contributor

Sorry @pablogsal, I had trouble checking out the 3.8 backport branch.
Please backport using cherry_picker on command line.
cherry_picker 41f0ef6abbd304409c55612a08788cdd59fbc8a3 3.8

@miss-islington
Copy link
Contributor

Sorry, @pablogsal, I could not cleanly backport this to 3.7 due to a conflict.
Please backport using cherry_picker on command line.
cherry_picker 41f0ef6abbd304409c55612a08788cdd59fbc8a3 3.7

@pablogsal pablogsal deleted the bpo-39427 branch January 23, 2020 01:15
@pablogsal
Copy link
Member Author

Will backport this tomorrow :)

pablogsal added a commit to pablogsal/cpython that referenced this pull request Jan 23, 2020
@bedevere-bot
Copy link

GH-18133 is a backport of this pull request to the 3.8 branch.

@bedevere-bot
Copy link

GH-18134 is a backport of this pull request to the 3.7 branch.

pablogsal added a commit to pablogsal/cpython that referenced this pull request Jan 23, 2020
pablogsal added a commit that referenced this pull request Feb 23, 2020
…n page (GH-18131) (GH-18133)

https://bugs.python.org/issue39427

Automerge-Triggered-By: @pablogsal
(cherry picked from commit 41f0ef6)

Co-authored-by: Pablo Galindo <[email protected]>
pablogsal added a commit that referenced this pull request Feb 23, 2020
…n page (GH-18131) (#18134)

https://bugs.python.org/issue39427

Automerge-Triggered-By: @pablogsal.
(cherry picked from commit 41f0ef6)

Co-authored-by: Pablo Galindo <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants