fix: Wrap help flags at 100 chars #2893
Merged
Conversation
This file contains hidden or 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
Because the actual flags take quite a bit of space, wrapping at 80 characters creates a very cramped output for e.g. `coder server`, for this reasons, flags are wrapped at 100 chars (vs. standard 80). The `Consumes $ENV_FLAG` message was put on a newline for consistency, this should allow users to learn where to look for the informations. Side note: we should perhaps stop adding period (`.`) at the end of flag descriptions to be consistent, for instance, command helps usually don't have one. This change fixes the biggest issue in #2363, but not all `--help` output is guaranteed (yet) to wrap at 80-100 chars. Fixes #2363
kylecarbs
approved these changes
Jul 11, 2022
|
Great change. The non-wrapped text was difficult to read! |
Emyrk
approved these changes
Jul 11, 2022
| @@ -348,12 +348,12 @@ func usageTemplate() string { | |||
|
|
|||
| {{- if .HasAvailableLocalFlags}} | |||
| {{usageHeader "Flags:"}} | |||
| {{.LocalFlags.FlagUsages | trimTrailingWhitespaces}} | |||
| {{.LocalFlags.FlagUsagesWrapped 100}} | |||
There was a problem hiding this comment.
Same here, we have pflag to thank ❤️! 😄
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.
Because the actual flags take quite a bit of space, wrapping at 80
characters creates a very cramped output for e.g.
coder server, forthis reasons, flags are wrapped at 100 chars (vs. standard 80).
The
Consumes $ENV_FLAGmessage was put on a newline for consistency,this should allow users to learn where to look for the informations.
Side note: we should perhaps stop adding period (
.) at the end of flagdescriptions to be consistent, for instance, command helps usually don't
have one.
This change fixes the biggest issue in #2363, but not all
--helpoutput is guaranteed (yet) to wrap at 80-100 chars.
Fixes #2363