fix(help text): wrap flag help texts within a column #862
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
The flags help text does not wrap within the column, making it more difficult to read. If the flag description spills over a line it will start from the left instead of where the previous line started.
Current behavior:
Flags: --color string Output coloring. Accepted values: always, never, auto. (default "auto") --command-timeout duration The command execution timeout. 0s means no timeout. (default 0s) --config-file $CONFIG_PATH/temporal/temporal.toml File path to read TOML config from, defaults to $CONFIG_PATH/temporal/temporal.toml where `$CONFIG_PATH` is defined as `$HOME/ .config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. EXPERIMENTAL. --disable-config-env If set, disables loading environment config from environment variables. EXPERIMENTAL. --disable-config-file If set, disables loading environment config from config file. EXPERIMENTAL. --env ENV Active environment name (ENV). (default "default") --env-file $HOME/.config/temporalio/temporal.yaml Path to environment settings file. Defaults to $HOME/.config/temporalio/temporal.yaml. -h, --help help for temporal --log-format string Log format. Accepted values: text, json. (default "text") --log-level server start-dev Log level. Default is "info" for most commands and "warn" for server start-dev. Accepted values: debug, info, warn, error, nev er. (default "info") --no-json-shorthand-payloads Raw payload output, even if the JSON option was used. -o, --output string Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") --profile string Profile to use for config file. EXPERIMENTAL. --time-format string Time format. Accepted values: relative, iso, raw. (default "relative") -v, --version version for temporalNew behavior:
Flags: --client-connect-timeout duration The client connection timeout. 0s means no timeout. (default 0s) --color string Output coloring. Accepted values: always, never, auto. (default "auto") --command-timeout duration The command execution timeout. 0s means no timeout. (default 0s) --config-file $CONFIG_PATH/temporal/temporal.toml File path to read TOML config from, defaults to $CONFIG_PATH/temporal/temporal.toml where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. EXPERIMENTAL. --disable-config-env If set, disables loading environment config from environment variables. EXPERIMENTAL. --disable-config-file If set, disables loading environment config from config file. EXPERIMENTAL. --env ENV Active environment name (ENV). (default "default") --env-file $HOME/.config/temporalio/temporal.yaml Path to environment settings file. Defaults to $HOME/.config/temporalio/temporal.yaml. -h, --help help for temporal --log-format string Log format. Accepted values: text, json. (default "text") --log-level server start-dev Log level. Default is "info" for most commands and "warn" for server start-dev. Accepted values: debug, info, warn, error, never. (default "info") --no-json-shorthand-payloads Raw payload output, even if the JSON option was used. -o, --output string Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") --profile string Profile to use for config file. EXPERIMENTAL. --time-format string Time format. Accepted values: relative, iso, raw. (default "relative") -v, --version version for temporalWhy?
Better readability
Checklist
Closes NA
How was this tested:
Tested manually
Any docs updates needed?
No