doc: Remove leading spaces in examples in GenMarkdownCustom #2345
+28
−2
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
In order to have consistent indentation with the other sections of the usage message (like "Usage" and "Flags"), many commands prefix each line in the examples string with two spaces. That looks odd in the generated markdown, so we remove the two-space prefix there, if all lines are prefixed like that.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
In order to have consistent indentation with the other sections of the usage message (like
UsageandFlags), many commands prefix each line in the examples string with two spaces [1]. That looks odd in the generated markdown, so we remove the two-space prefix there, if all lines are prefixed like that.[1] An example is the
cmd.Examplestring provided in the Generate CLI Docs with Cobra guide.Related: #1905