spf13 / cobra

A Commander for modern Go CLI interactions
https://cobra.dev
Apache License 2.0
37.8k stars 2.83k forks source link

Capitalized letter #2168

Closed JungleHornet closed 2 months ago

JungleHornet commented 2 months ago

I noticed that the default help message had this for flags:

Flags:
  -h, --help     help for [project-name]
  -t, --toggle   Help message for toggle

So I capitalized the letter so both lines would be the same and now it is as follows:

Flags:
  -h, --help     Help for [project-name]
  -t, --toggle   Help message for toggle
CLAassistant commented 2 months ago

CLA assistant check
All committers have signed the CLA.

marckhouzam commented 2 months ago

The convention with Cobra is that all flag name description start with a lower case letter. For example:

$ helm -h | egrep -e ' --'
      --burst-limit int                 client-side default throttling limit (default 100)
      --debug                           enable verbose output
  -h, --help                            help for helm
      --kube-apiserver string           the address and the port for the Kubernetes API server
      --kube-as-group stringArray       group to impersonate for the operation, this flag can be repeated to specify multiple groups.
      --kube-as-user string             username to impersonate for the operation
      --kube-ca-file string             the certificate authority file for the Kubernetes API server connection
      --kube-context string             name of the kubeconfig context to use
      --kube-insecure-skip-tls-verify   if true, the Kubernetes API server's certificate will not be checked for validity. This will make your HTTPS connections insecure
      --kube-tls-server-name string     server name to use for Kubernetes API server certificate validation. If it is not provided, the hostname used to contact the server is used
      --kube-token string               bearer token used for authentication
      --kubeconfig string               path to the kubeconfig file
  -n, --namespace string                namespace scope for this request
      --registry-config string          path to the registry config file (default "/Users/kmarc/Library/Preferences/helm/registry/config.json")
      --repository-cache string         path to the file containing cached repository indexes (default "/Users/kmarc/Library/Caches/helm/repository")
      --repository-config string        path to the file containing repository names and URLs (default "/Users/kmarc/Library/Preferences/helm/repositories.yaml")
Use "helm [command] --help" for more information about a command.

If you see -t, --toggle Help message for toggle it is probably your program that specified this message with an uppercase. That is where it should be fixed.

JungleHornet commented 2 months ago

Oh ok, thanks. I don’t think that I have changed anything with the toggle flag description so I’ll see if that’s a typo in cobra-generator and if I can fix it.