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

Help section titles should be capitalized #66

Open
holgerbrandl opened this issue Sep 7, 2018 · 2 comments
Open

Help section titles should be capitalized #66

holgerbrandl opened this issue Sep 7, 2018 · 2 comments

Comments

@holgerbrandl
Copy link

I guess there is no real consistent scheme, but quite a few tools capitalize the help section headers.
So maybe a flag could be added to do the same when using kotlin-argparser.

So showiing

Usage: [-h] [-a] IMAGE-DIRECTORY MARKDOWN-FILES...

Optional arguments:
  -h, --help        show this help message and exit

  -a, --auto        Automatically remove orphan images


Positional arguments:

instead of

usage: [-h] [-a] IMAGE-DIRECTORY MARKDOWN-FILES...

optional arguments:
  -h, --help        show this help message and exit

  -a, --auto        Automatically remove orphan images


positional arguments:
@xenomachina
Copy link
Owner

That part of the formatting is modeled after Python's argparse module. As you mention, there isn't a lot of consistency around this.

What do you think about adding parameters for the various headers to DefaultHelpFormatter? Then one could not only change the capitalization, but even change the language for a non-English (or internationalized) application. (That doesn't solve I18n for error messages, though.)

@holgerbrandl
Copy link
Author

Adding a capitalization parameter to the help-formatter would be a great improvement imho.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants