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 #12931

Merged
merged 1 commit into from
Oct 15, 2024

Conversation

Hasaber8
Copy link
Contributor

Adapting to language suggested in - (#12897)

Change-Id: Ib27a4a7b540d45243e6252db769d4b9fb7447718

@CLAassistant
Copy link

CLAassistant commented Oct 14, 2024

CLA assistant check
All committers have signed the CLA.

@@ -70,17 +70,17 @@ hugo [flags]

### SEE ALSO

* [hugo build](/commands/hugo_build/) - build builds your site
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The CLI docs is generated with go run main.go gen doc --dir docs/content/en/commands, something we typically do before we release.

As to this PR, it would be much easier to review it without all the docs changes. So could you revert the docs folder to master and force push the PR branch?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done!

@bep
Copy link
Member

bep commented Oct 14, 2024

This looks very good, but there are some failing test assertions.

@Hasaber8
Copy link
Contributor Author

This looks very good, but there are some failing test assertions.

Updated.

@jmooring
Copy link
Member

There are two remaining subcommands to address: version and build.

Current (with this PR):

Available Commands:
  build       build builds your site
  ...
  version     Display version and environment info

As suggested in #12897:

Available Commands:
  build       Build your site
  ...
  version     Display version

@Hasaber8
Copy link
Contributor Author

There are two remaining subcommands to address: version and build.

Current (with this PR):

Available Commands:
  build       build builds your site
  ...
  version     Display version and environment info

As suggested in #12897:

Available Commands:
  build       Build your site
  ...
  version     Display version

Updated!

@jmooring
Copy link
Member

Now we have this:

Available Commands:
  build       Build your site
  ...
  env         Display version
  ...
  version     Display version

The env description should be "Display version and environment info". The env and version subcommands do different things.

commands/convert.go Outdated Show resolved Hide resolved
commands/import.go Outdated Show resolved Hide resolved
@Hasaber8
Copy link
Contributor Author

@jmooring made the requested changes.

@jmooring
Copy link
Member

jmooring commented Oct 14, 2024

This still isn't correct. See my previous comment regarding "version" vs. "env".

@Hasaber8
Copy link
Contributor Author

Hasaber8 commented Oct 14, 2024

This still isn't correct. See my previous comment regarding "version" vs. "env".

Screenshot 2024-10-14 at 17 06 43

I misread that one, its updated now.

@jmooring
Copy link
Member

You have at least one failing test. Run mage -v test locally.

@Hasaber8
Copy link
Contributor Author

You have at least one failing test. Run mage -v test locally.

Fixed.

@jmooring
Copy link
Member

This looks good. Please squash the commits, change the commit message to "Closes #12897", and force push.

@Hasaber8
Copy link
Contributor Author

This looks good. Please squash the commits, change the commit message to "Closes #12897", and force push.

All squashed!

@jmooring
Copy link
Member

This is a nit, but please change this:

- Closes #12897

To what I asked for in my previous comment:

Closes #12897

See https://github.com/gohugoio/hugo/blob/master/CONTRIBUTING.md#git-commit-message-guidelines.

@Hasaber8
Copy link
Contributor Author

This is a nit, but please change this:

- Closes #12897

To what I asked for in my previous comment:

Closes #12897

See https://github.com/gohugoio/hugo/blob/master/CONTRIBUTING.md#git-commit-message-guidelines.

Done, will keep this in mind for future contributions.

Thank you very much for the tool.

@jmooring
Copy link
Member

Current commit message:

Closes (#12897)

What I asked for:

Closes #12897

Closes gohugoio#12897

Change-Id: Ib27a4a7b540d45243e6252db769d4b9fb7447718
Signed-off-by: Rohan Hasabe <rohanhasabe8@gmail.com>
@bep bep merged commit 6b5e117 into gohugoio:master Oct 15, 2024
6 checks passed
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.

4 participants