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

commands: Use consistent style when describing subcommands #12897

Closed
jmooring opened this issue Sep 30, 2024 · 1 comment
Closed

commands: Use consistent style when describing subcommands #12897

jmooring opened this issue Sep 30, 2024 · 1 comment
Milestone

Comments

@jmooring
Copy link
Member

jmooring commented Sep 30, 2024

This is a nit. I suggest that we:

  • Use imperative mood
  • Use sentence case
  • Omit the trailing period

current

Available Commands:
  build       build builds your site
  completion  Generate the autocompletion script for the specified shell
  config      Print the site configuration
  convert     Convert your content to different formats
  deploy      Deploy your site to a Cloud provider.
  env         Print Hugo version and environment info
  gen         A collection of several useful generators.
  help        Help about any command
  import      Import your site from others.
  list        Listing out various types of content
  mod         Various Hugo Modules helpers.
  new         Create new content for your site
  server      A high performance webserver
  version     Print Hugo version and environment info

suggested

Available Commands:
  build       Build your site
  completion  Generate an autocompletion script for the specified shell
  config      Display site configuration
  convert     Convert front matter to another format
  deploy      Deploy your site to a cloud provider
  env         Display version and environment info
  gen         Generate documentation and syntax highlighting styles
  help        Display help about any command
  import      Import a site from another system
  list        List content
  mod         Manage modules
  new         Create new content
  server      Start the embedded web server
  version     Display version

Make similar changes to child subcommands.

@bep bep added this to the v0.136.0 milestone Sep 30, 2024
Hasaber8 added a commit to Hasaber8/hugo that referenced this issue Oct 14, 2024
For - (gohugoio#12897)

Change-Id: Ib27a4a7b540d45243e6252db769d4b9fb7447718
Signed-off-by: Rohan Hasabe <[email protected]>
@Hasaber8
Copy link
Contributor

Not sure if it picked up yet or not, but I have raised an PR for it;
#12931

Hasaber8 added a commit to Hasaber8/hugo that referenced this issue Oct 14, 2024
For - (gohugoio#12897)

Change-Id: Ib27a4a7b540d45243e6252db769d4b9fb7447718
Signed-off-by: Rohan Hasabe <[email protected]>
Hasaber8 added a commit to Hasaber8/hugo that referenced this issue Oct 14, 2024
- Closes (gohugoio#12897)

Change-Id: Ib27a4a7b540d45243e6252db769d4b9fb7447718
Signed-off-by: Rohan Hasabe <[email protected]>
Hasaber8 added a commit to Hasaber8/hugo that referenced this issue Oct 15, 2024
Closes (gohugoio#12897)

Change-Id: Ib27a4a7b540d45243e6252db769d4b9fb7447718
Signed-off-by: Rohan Hasabe <[email protected]>
Hasaber8 added a commit to Hasaber8/hugo that referenced this issue Oct 15, 2024
Closes gohugoio#12897

Change-Id: Ib27a4a7b540d45243e6252db769d4b9fb7447718
Signed-off-by: Rohan Hasabe <[email protected]>
@bep bep closed this as completed in 6b5e117 Oct 15, 2024
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

3 participants