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 #1149

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

DimitriPapadopoulos
Copy link
Contributor

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

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

This change has already been applied to setuptools (pypa/setuptools#4442).

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
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant