Remove indent when generating Example lines in usage #188
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
Signed-off-by: Vui Lam <vui.lam@broadcom.com>
vuil
force-pushed
the
fix-example-indent-in-usage
branch
from
68d7c2f
to
b26c6c5
Compare
vuil
commented
May 2, 2024
| // matches cobra default help template's behavior of not indenting the | ||
| // Example value, which has the added benefit of ensuring multiline | ||
| // .Example values are aligned | ||
| output.WriteString(cmd.Example + "\n") |
There was a problem hiding this comment.
I did consider correcting commands that still includes explicit indent in multi-line Example fields, but in the spirit discourage such patterns going foward (because it leads to misalignment of generated markdown docs for said commands), decided not to.
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.
What this PR does / why we need it
Which issue(s) this PR fixes
Fixes #
Describe testing done for PR
See updated unit tests
Release note
Additional information
Special notes for your reviewer