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
Make --help output more consistent and narrower #10556
base: master
Are you sure you want to change the base?
Conversation
"-t TIMEOUT_MULTIPLIER, --timeout-multiplier TIMEOUT_MULTIPLIER" made the output very wide. Let's use METAVAR with short names to reduce output width, and also provide a hint to the user what type of value is expected, e.g. "-C DIRECTORY" is better than "-C WD".
Argparse doesn't use dots at the end, so some --help lines had a dot, and some didn't. So drop them everywhere for consistency. Also, sentences are capitalized and some texts are reworded a bit.
Codecov Report
@@ Coverage Diff @@
## master #10556 +/- ##
==========================================
- Coverage 68.82% 68.80% -0.02%
==========================================
Files 406 406
Lines 87954 87954
Branches 19540 19540
==========================================
- Hits 60536 60521 -15
- Misses 22850 22864 +14
- Partials 4568 4569 +1
Continue to review full report at Codecov.
|
Hmm, but why not add them everywhere for consistency? e.g. now you end up with some --help lines containing multiple sentences where only the first sentence has a dot. |
Two reasons: 1. there's an autogenerated messages for |
But this:
also refrains from capitalizing the first word, while you went ahead and capitalized all the manually defined option entries, so the autogenerated --help is still inconsistent. So I don't see the problem with making this one autogenerated message be inconsistent about the dot as well. |
Yes, that's true. But consistency is just one of the reasons. The other reason is that it's just better to not have the dots, as described above. Most --help outputs don't. |
No description provided.