Improve description of duration argument

nginx · Oct 20, 2023 · 45789b0 · 45789b0
1 parent 7d57948
commit 45789b0
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 4 deletions.
diff --git a/cmd/gateway/commands.go b/cmd/gateway/commands.go
@@ -339,7 +339,7 @@ func createSleepCommand() *cobra.Command {
 		&duration,
 		durationFlag,
 		30*time.Second,
-		"Set the duration of sleep",
+		"Set the duration of sleep. Must be parsable by https://pkg.go.dev/time#ParseDuration",
 	)
 
 	return cmd

diff --git a/docs/cli-help.md b/docs/cli-help.md
@@ -41,6 +41,9 @@ Usage:
   gateway sleep [flags]
 ```
 
-| Name     | Type       | Description                               |
-|----------|------------|-------------------------------------------|
-| duration | `duration` | Set the duration of sleep (default `30s`) |
+| Name     | Type            | Description                                                                                           |
+|----------|-----------------|-------------------------------------------------------------------------------------------------------|
+| duration | `time.Duration` | Set the duration of sleep. Must be parsable by [`time.ParseDuration`][parseDuration]. (default `30s`) |
+
+
+[parseDuration]:https://pkg.go.dev/time#ParseDuration