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

fix(help): Don't rely on ALL CAPS for headers #4123

Merged
merged 1 commit into from Aug 26, 2022

Conversation

epage
Copy link
Member

@epage epage commented Aug 26, 2022

I see them fulfilling two roles

  • A form of bolding
  • As a callback to their placeholder in usage

However, it is a bit of an unpolished look and no other CLI seems to do
it. This looks a bit more proefessional. We have colored help for
formatting and I think the sections relation to usage will be clear
enough.

image

I see them fulfilling two roles
- A form of bolding
- As a callback to their placeholder in usage

However, it is a bit of an unpolished look and no other CLI seems to do
it.  This looks a bit more proefessional.  We have colored help for
formatting and I think the sections relation to usage will be clear
enough.
@epage epage merged commit aacb562 into clap-rs:master Aug 26, 2022
20 checks passed
@epage epage deleted the header-help branch August 26, 2022 15:41
epage added a commit to epage/clap that referenced this pull request Aug 31, 2022
In switching to title case for help headings (clap-rs#4123), it caused me to
look at "subcommand" in a fresh light.  I can't quite put my finger on
it but "Subcommand" looks a bit sloppy.  I also have recently been
surveying other CLIs and they just use "command" as well.

All of them are commands anyways, just some are children of others
(subcommands) while others are not (root or top-level commands, or just
command).  Context is good enough for clarifying subcommands from root
commands.

This is part of clap-rs#4132
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.

None yet

1 participant