doc: add word wrap support for Short and Long in generated markdown#2410
Open
FMarcelFC wants to merge 1 commit into
Open
doc: add word wrap support for Short and Long in generated markdown#2410FMarcelFC wants to merge 1 commit into
FMarcelFC wants to merge 1 commit into
Conversation
Adds GenMarkdownCustomWithOptions and GenMarkdownTreeCustomWithOptions with a MarkdownOptions.WrapWidth field. WrapWidth=0 preserves existing behavior. Example is intentionally excluded as it renders in a code fence. Closes spf13#2282
|
|
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary
GenMarkdownCustomWithOptionsandGenMarkdownTreeCustomWithOptionswith aMarkdownOptionsstructMarkdownOptions.WrapWidthsets the max line length forShortandLongfields;0disables wrapping (fully backward-compatible)cmd.Exampleis intentionally excluded: it renders inside a Markdown code fence which is always verbatim; wrapping it would corrupt command syntaxTest plan
TestGenMdDocWithOptions_NoWrap:WrapWidth=0produces identical output toGenMarkdownCustomTestGenMdDocWithOptions_WrapWidth: prose lines respect the configured widthTestGenMdDocWithOptions_PreservesExistingNewlines: existing\nin text is not re-joinedTestGenMdDocWithOptions_MatchesGenMarkdownCustom: output identity with zero optionsTestGenMdTreeCustomWithOptions: tree variant generates files correctlygo test ./...)Closes #2282