Generators/Markdown: fix line break and indentation handling #737
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
As things were, line breaks in a `<standard>` block were not respected for proper display in markdown.
As a side-effect of this, an indented text line in a `<standard>` block directly after a blank line, would unintentionally cause the markdown to display the line as a code block (via the indentation).
This has now been fixed by:
* Trimming indentation off each line.
* Adding two spaces to the end of each line as long as the line is not followed by a blank line or at the end of the standard block.
The two spaces will ensure markdown will recognize the line break (in most markdown flavours).
Includes updated test expectations.
Refs:
* https://www.markdownguide.org/basic-syntax/#paragraph-best-practices
* https://www.markdownguide.org/basic-syntax/#line-break-best-practices
* https://daringfireball.net/projects/markdown/syntax#p
jrfnl
deleted the
feature/generator-markdown-fix-line-break-indentation-handling
branch
# for free
to join this conversation on GitHub.
Already have an account?
# 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.
Description
As things were, line breaks in a
<standard>block were not respected for proper display in markdown.As a side-effect of this, an indented text line in a
<standard>block directly after a blank line, would unintentionally cause the markdown to display the line as a code block (via the indentation).This has now been fixed by:
Includes updated test expectations.
Refs:
Before
After
Suggested changelog entry
Generators/Markdown: line breaks in blocks will now be respected when generating the Markdown documentation.
This also prevents additional paragraphs from being displayed as code blocks.
Related issues/external references
This PR is part of a series of PRs which will add a complete set of tests (and improvements) for the Generator feature.
Also see: #671 and #717.
Types of changes