cli.argparser: rewrite and fix help texts #6255
Conversation
bastimeyer
commented
Oct 18, 2024
bastimeyer
commented
- Remove unnecessary line breaks and adjust line length in preparation for indentation changes
- Fix minor spelling, grammar and punctuation errors, as well as names
- Rephrase and always use imperative or a descriptive style without talking to the reader or in third person
- Use common style when enumerating possible values
- Reference other related arguments where it makes sense
- Explicitly mention stdout/stderr instead of console output
- Rewrite incorrect/inaccurate and outdated help texts
- Remove unnecessary line breaks and adjust line length in preparation for indentation changes - Fix minor spelling, grammar and punctuation errors, as well as names - Rephrase and always use imperative or a descriptive style without talking to the reader or in third person - Use common style when enumerating possible values - Reference other related arguments where it makes sense - Explicitly mention stdout/stderr instead of console output - Rewrite incorrect/inaccurate and outdated help texts
bastimeyer
force-pushed
the
cli/argparse/update-help-texts
branch
from
378433b to
1844afc
Compare
|
Please have a quick look when you have the time for any obvious mistakes or potentially confusing stuff, @gravyboat. Also the unchanged help texts. See the rendered docs. |
|
If nobody's had a look at this until the end of tomorrow, I'm going to merge regardless. I don't think there's anything wrong here, and if there are any potential improvements (which I'm sure there always are), then those can be made later on. The current changes are already an improvement. The reason I don't want to wait is that I have formatting changes queued up ( |
