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.

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

Use brackets for the default value of option arguments #262

Merged
merged 1 commit into from
Jun 28, 2024

Conversation

DimitriPapadopoulos
Copy link
Contributor

@DimitriPapadopoulos DimitriPapadopoulos commented Jun 27, 2024

The goal is to standardize the format of the help text printed by commands. It's not easy to choose between brackets [] and parentheses (). I went for the docopt style, which is the closest to a standard I could find:

[...] and whether that argument has a default value ([default: 10]).

Fixes #251.

@DimitriPapadopoulos DimitriPapadopoulos marked this pull request as ready for review June 27, 2024 19:27
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]).
@jaraco jaraco merged commit ec8b191 into pypa:main Jun 28, 2024
16 checks passed
@DimitriPapadopoulos DimitriPapadopoulos deleted the default branch June 28, 2024 14:48
DimitriPapadopoulos added a commit to DimitriPapadopoulos/setuptools that referenced this pull request Jun 28, 2024
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 added a commit to DimitriPapadopoulos/setuptools that referenced this pull request Jun 28, 2024
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 added a commit to DimitriPapadopoulos/wheel that referenced this pull request Jun 28, 2024
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
jaraco added a commit that referenced this pull request Jun 28, 2024
Use brackets for the default value of option arguments
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.

[default: ] vs. (default: )
2 participants