Clarify Versioning CLI Commands #606
Open
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
…uild-id flag description
|
|
cretz
reviewed
Jun 27, 2024
| @@ -1344,7 +1344,7 @@ func NewTemporalTaskQueueDescribeCommand(cctx *CommandContext, parent *TemporalT | |||
| s.Command.Flags().StringVarP(&s.TaskQueue, "task-queue", "t", "", "Task queue name. Required.") | |||
| _ = cobra.MarkFlagRequired(s.Command.Flags(), "task-queue") | |||
| s.Command.Flags().StringArrayVar(&s.TaskQueueType, "task-queue-type", nil, "Task queue types considered. If not specified, all types are reported. The current valid queue types are workflow, activity, or nexus.") | |||
| s.Command.Flags().StringArrayVar(&s.SelectBuildId, "select-build-id", nil, "Task queue filter based on Build ID.") | |||
| s.Command.Flags().StringArrayVar(&s.SelectBuildId, "select-build-id", nil, "Task queue filter based on Build ID. If not specified, the default Build ID will be used.") | |||
There was a problem hiding this comment.
This file is auto-generated, you have to update the commands.md source and regen. See CONTRIBUTING.md.
| @@ -1344,7 +1344,7 @@ func NewTemporalTaskQueueDescribeCommand(cctx *CommandContext, parent *TemporalT | |||
| s.Command.Flags().StringVarP(&s.TaskQueue, "task-queue", "t", "", "Task queue name. Required.") | |||
| _ = cobra.MarkFlagRequired(s.Command.Flags(), "task-queue") | |||
| s.Command.Flags().StringArrayVar(&s.TaskQueueType, "task-queue-type", nil, "Task queue types considered. If not specified, all types are reported. The current valid queue types are workflow, activity, or nexus.") | |||
| s.Command.Flags().StringArrayVar(&s.SelectBuildId, "select-build-id", nil, "Task queue filter based on Build ID.") | |||
| s.Command.Flags().StringArrayVar(&s.SelectBuildId, "select-build-id", nil, "Task queue filter based on Build ID. If not specified, the default Build ID will be used.") | |||
There was a problem hiding this comment.
What's the default Build ID? Is that something the user specifies in an assignment rule or another command? If so, maybe add a breadcrumb. (sometimes it's good to use code names rather describe things indirectly in english)
There was a problem hiding this comment.
The default Build ID is described in the command description. There is also a catch-all comment about default values on --select-* so there is no need to add one for each. See commandsmd/commands.md
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.
What was changed
commit-build-id, fix spelling--select-build-idflag descriptionWhy?
commit-build-iddoes not touch redirect rules, only assignment rules--select-build-idChecklist
Closes
How was this tested: