Skip to content

Add a long command description for secrets remove#3786

Merged
mislav merged 1 commit intocli:trunkfrom
browniebroke:remove-secret-long-description
Jun 4, 2021
Merged

Add a long command description for secrets remove#3786
mislav merged 1 commit intocli:trunkfrom
browniebroke:remove-secret-long-description

Conversation

@browniebroke
Copy link
Contributor

I noticed that the set and list commands have short and long description but remove has only a short one which is more like a long one.

 ➜ gh secret --help
Secrets can be set at the repository, environment, or organization level for use in
GitHub Actions. Run "gh help secret set" to learn how to get started.


USAGE
  gh secret <command> [flags]

CORE COMMANDS
  list:       List secrets
  remove:     Remove an organization, environment, or repository secret
  set:        Create or update secrets

Would probably be better for consistency to have the current comamnd description be defined as long one.

@cliAutomation
Copy link
Collaborator

Hi! Thanks for the pull request. Please ensure that this change is linked to an issue by mentioning an issue number in the description of the pull request. If this pull request would close the issue, please put the word 'Fixes' before the issue number somewhere in the pull request body. If this is a tiny change like fixing a typo, feel free to ignore this message.

Copy link
Contributor

@mislav mislav left a comment

Choose a reason for hiding this comment

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

Makes sense! Thank you for looking out for good documentation :)

@mislav mislav merged commit 75abeb1 into cli:trunk Jun 4, 2021
@browniebroke browniebroke deleted the remove-secret-long-description branch June 4, 2021 18:22
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.

3 participants