Skip to content

Commit b562b32

Browse files
authored
update --command-timeout description (#694)
## What was changed update `--command-timeout` description per docs feedback ## Why? make it more clear ## Checklist 1. How was this tested: locally with `go run ./cmd/temporal operator nexus endpoint create --help` 2. Any docs updates needed? yes, see related: - temporalio/documentation#3162 --------- Signed-off-by: Phil Prasek <prasek@gmail.com> Signed-off-by: Josh Berry <josh.berry@temporal.io>
1 parent cd53985 commit b562b32

2 files changed

Lines changed: 3 additions & 2 deletions

File tree

temporalcli/commands.gen.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -311,7 +311,7 @@ func NewTemporalCommand(cctx *CommandContext) *TemporalCommand {
311311
s.Command.PersistentFlags().Var(&s.Color, "color", "Output coloring. Accepted values: always, never, auto.")
312312
s.Command.PersistentFlags().BoolVar(&s.NoJsonShorthandPayloads, "no-json-shorthand-payloads", false, "Raw payload output, even if the JSON option was used.")
313313
s.CommandTimeout = 0
314-
s.Command.PersistentFlags().Var(&s.CommandTimeout, "command-timeout", "Timeout for the span of a command.")
314+
s.Command.PersistentFlags().Var(&s.CommandTimeout, "command-timeout", "The command execution timeout. 0s means no timeout.")
315315
s.initCommand(cctx)
316316
return &s
317317
}

temporalcli/commandsgen/commands.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -197,7 +197,8 @@ commands:
197197
description: Raw payload output, even if the JSON option was used.
198198
- name: command-timeout
199199
type: duration
200-
description: Timeout for the span of a command.
200+
description: |
201+
The command execution timeout. 0s means no timeout.
201202
202203
- name: temporal activity
203204
summary: Complete or fail an Activity

0 commit comments

Comments
 (0)