kubernetes: remove backquotes from flag descriptions #1510
Closed
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
Remove backquotes from flag descriptions in the kubernetes subcommands, because those backquotes cause pflag's usage parser to extract them and treat them as a flag name to try to determine the data type of the flag. The practical effect of this was that the help was borderline unreadable because the description was forced so far right and narrow.
|
Requested a review from @dbrian57 for impact on pdocs. |
|
This does improve on the existing experience on the CLI. Top pane is the most recent release and the bottom one is built from this PR:
|
timoreimann
reviewed
Mar 8, 2024
| @@ -264,46 +264,46 @@ Retrieves a list of slugs representing Kubernetes upgrade versions you can use t | |||
|
|
|||
| cmdKubeClusterCreate := CmdBuilder(cmd, k8sCmdService.RunKubernetesClusterCreate(defaultKubernetesNodeSize, | |||
| defaultKubernetesNodeCount), "create <name>", "Create a Kubernetes cluster", ` | |||
| Creates a Kubernetes cluster given the specified options and using the specified name. Before creating the cluster, you can use `+"`"+`doctl kubernetes options`+"`"+` to see possible values for the various configuration flags. | |||
| Creates a Kubernetes cluster given the specified options and using the specified name. Before creating the cluster, you can use doctl kubernetes options to see possible values for the various configuration flags. | |||
There was a problem hiding this comment.
Could we use regular quotes instead of backtick quotes to retain the command delimiters?
|
@timoreimann I refactored and put up #1511 as an alternative PR that I think is a better change, because it provides an even more useful usage message without dropping the backquotes around some commands. |
|
Closing as this was superseded by #1511 |
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.
Remove backquotes from flag descriptions in the kubernetes subcommands, because those backquotes cause pflag's usage parser to extract them and treat them as a flag name to try to determine the data type of the flag. The practical effect of this was that the help was borderline unreadable because the description was forced so far right and narrow.