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

Uppercase first char in short desc of generate command #1485

Closed

Conversation

samherrmann
Copy link

This commit provides consistency of the letter casing in the short
description between commands. Both the short description as well as
documented examples have the first character in the short description in
uppercase. The generate command was the exception by having the first
character of the short description in lowercase, creating an
inconsistent help menu for the user:

Available Commands:
  add              Add a command to a Cobra Application
  completion       generate the autocompletion script for the specified shell
  help             Help about any command
  init             Initialize a Cobra Application

This commit provides consistency of the letter casing in the short
description between commands. Both the short description as well as
documented examples have the first character in the short description in
uppercase. The generate command was the exception by having the first
character of the short description in lowercase, creating an
inconsistent help menu for the user:

```sh
Available Commands:
  add         Add a command to a Cobra Application
  completion  generate the autocompletion script for the specified shell
  help        Help about any command
  init        Initialize a Cobra Application
```

* User Guide Example: https://github.com/spf13/cobra/blob/v1.2.1/user_guide.md#example
* Help command: https://github.com/spf13/cobra/blob/master/command.go#L1080
@CLAassistant
Copy link

CLAassistant commented Sep 10, 2021

CLA assistant check
All committers have signed the CLA.

@marckhouzam
Copy link
Collaborator

Thanks @samherrmann.
This is a duplicate of a slightly larger ajustement in #1455.

@samherrmann
Copy link
Author

Wow, I'm not sure how I missed that PR given that it's near to the top.

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

3 participants