Skip to content

Change description for custom states (AST-80216) #1036

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.

Sign up for GitHub

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

Closed
cx-itay-paz wants to merge 1 commit into from
Closed

Change description for custom states (AST-80216) #1036

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions internal/commands/predicates.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Copy link

@github-actions github-actions bot Feb 5, 2025

Choose a reason for hiding this comment

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

Consider rephrasing the Short description to be more concise and consistent with command description conventions. For example: List configured custom states in the tenant.

Long: "The get-states command shows information about each of the custom states that have been configured in your tenant account",
Copy link

@github-actions github-actions bot Feb 5, 2025

Choose a reason for hiding this comment

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

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.

Example: heredoc.Doc(
`
$ cx triage get-states
Expand All @@ -46,7 +46,7 @@ func triageGetStatesSubCommand(customStatesWrapper wrappers.CustomStatesWrapper)
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")
Copy link

@github-actions github-actions bot Feb 5, 2025

Choose a reason for hiding this comment

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

Consider rephrasing the flag description to maintain consistency with the existing style. For example, 'Include all custom states, even those that have been deleted.'


return triageGetStatesCmd
}
Expand Down
Loading