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

[default: ] vs. (default: ) #251

Closed
DimitriPapadopoulos opened this issue May 8, 2024 · 3 comments · Fixed by #262
Closed

[default: ] vs. (default: ) #251

DimitriPapadopoulos opened this issue May 8, 2024 · 3 comments · Fixed by #262

Comments

@DimitriPapadopoulos
Copy link
Contributor

I see a mixture of [default: ...] and (default: ...) for default values of user options.

Is it on purpose? If so, what meaning does either version convey? If not, would it be OK to standardise?

@DimitriPapadopoulos
Copy link
Contributor Author

See pypa/setuptools#4421.

@jaraco
Copy link
Member

jaraco commented Jun 26, 2024

I'm unaware of any intent behind the difference. Feel free to spelunk the blame history to see if the commit messages provide any insight, or don't and we can proceed with standardizing. I have no preference.

@DimitriPapadopoulos
Copy link
Contributor Author

The blame history of a few examples does not provide any insight.

I suggest using [default: ]. The closest to a "standard" that defines how default values should be printed is perhaps docopt:

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

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 a pull request may close this issue.

2 participants