Change description for custom states (AST-80216) #1036
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Korjen97
requested review from
AlvoBen,
greensd4 and
miryamfoiferCX
as code owners
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| @@ -35,8 +35,8 @@ func NewResultsPredicatesCommand(resultsPredicatesWrapper wrappers.ResultsPredic | |||
| func triageGetStatesSubCommand(customStatesWrapper wrappers.CustomStatesWrapper) *cobra.Command { | |||
| triageGetStatesCmd := &cobra.Command{ | |||
| Use: "get-states", | |||
| Short: "Fetch and display custom states.", | |||
| Long: "Retrieves a list of custom states and prints their names.", | |||
| Short: "Show the custom states that have been configured in your tenant", | |||
There was a problem hiding this comment.
Consider rephrasing the Short description to be more concise and consistent with command description conventions. For example: List configured custom states in the tenant.
| Short: "Fetch and display custom states.", | ||
| Long: "Retrieves a list of custom states and prints their names.", | ||
| Short: "Show the custom states that have been configured in your tenant", | ||
| Long: "The get-states command shows information about each of the custom states that have been configured in your tenant account", |
There was a problem hiding this comment.
The Long description seems verbose. Simplify to convey the necessary information more concisely. For example: Lists and displays details of all custom states configured in the tenant account.
| @@ -46,7 +46,7 @@ | |||
| RunE: runTriageGetStates(customStatesWrapper), | |||
| } | |||
|
|
|||
| triageGetStatesCmd.PersistentFlags().Bool(params.AllStatesFlag, false, "Include deleted states") | |||
| triageGetStatesCmd.PersistentFlags().Bool(params.AllStatesFlag, false, "Show all custom states, including the ones that have been deleted") | |||
There was a problem hiding this comment.
Consider rephrasing the flag description to maintain consistency with the existing style. For example, 'Include all custom states, even those that have been deleted.'
Korjen97
changed the title
|
Great job, no security vulnerabilities found in this Pull Request |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
By submitting a PR to this repository, you agree to the terms within the Checkmarx Code of Conduct. Please see the contributing guidelines for how to create and submit a high-quality PR for this repo.
Description
References
Testing
Checklist