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

Closed
wants to merge 1 commit into from

Conversation

DimitriPapadopoulos
Copy link
Contributor

@DimitriPapadopoulos DimitriPapadopoulos commented 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

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

This change has already been applied to distutils (pypa/distutils#262).

Fixes #616.

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
Copy link

codecov bot commented Jun 28, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 71.03%. Comparing base (1e00742) to head (84efd41).
Report is 5 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #626   +/-   ##
=======================================
  Coverage   71.03%   71.03%           
=======================================
  Files          13       13           
  Lines        1084     1084           
=======================================
  Hits          770      770           
  Misses        314      314           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@agronholm
Copy link
Contributor

Please do not send PRs against bdist_wheel.py, as wheel is no longer the canonical location for that command. I'm going to deprecate this module soon and remove it completely some time after that. If you want to work on bdist_wheel, the setuptools project is the right place for that. But even there I would prefer bdist_wheel to disappear completely in favor of the PEP 517 build back-end.

@agronholm agronholm closed this Jun 28, 2024
@DimitriPapadopoulos DimitriPapadopoulos deleted the default branch June 28, 2024 20:07
@DimitriPapadopoulos DimitriPapadopoulos restored the default branch July 8, 2024 18:42
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