Use brackets for the default value of option arguments #4442
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The goal is to standardize the format of the help text printed by commands. It is not easy to choose between brackets `[]` and parentheses `()`. I went for the docopt style, which is the closest to a standard I could find: http://docopt.org/ [...] and whether that argument has a default value ([default: 10]). This change has already been applied to distutils: pypa/distutils#262
DimitriPapadopoulos
force-pushed
the
default
branch
from
8c42664
to
d02b6b1
Compare
DimitriPapadopoulos
added a commit
to DimitriPapadopoulos/twine
that referenced
this pull request
Sep 21, 2024
The goal is to standardize the format of the help text printed by pypa commands. It is not easy to choose between brackets `[]` and parentheses `()`. I went for the docopt style, which is the closest to a standard I could find: http://docopt.org/ [...] and whether that argument has a default value ([default: 10]). This change has already been applied to setuptools: pypa/setuptools#4442
DimitriPapadopoulos
added a commit
to DimitriPapadopoulos/twine
that referenced
this pull request
Oct 31, 2024
The goal is to standardize the format of the help text printed by pypa commands. It is not easy to choose between brackets `[]` and parentheses `()`. I went for the docopt style, which is the closest to a standard I could find: http://docopt.org/ [...] and whether that argument has a default value ([default: 10]). This change has already been applied to setuptools: pypa/setuptools#4442
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary of changes
The goal is to standardize the format of the help text printed by commands. It is not easy to choose between brackets
[]and parentheses(). I went for the docopt style, which is the closest to a standard I could find:This change has already been applied to distutils (pypa/distutils#262).
Closes #4421
Pull Request Checklist
newsfragments/.(See documentation for details)