(PDOC-233) markdown whitespace fixes #170
Merged
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
Some variants of markdown do not convert atx-style headers correctly unless they are surrounded by blank lines. This commit adds blank lines to increase chances of rendering when using those variants while still maintaining compatibly with variants that do not require the surrounding blank lines. Also increases readability when viewing the raw markdown file.
Replace arbitrary double blank lines with a single blank lines.
Instead of specifying white space after each conditional, just add a blank line at the end of the conditional similar to the `function.erb` template.
|
this is awesome @JohnLyman ! Thanks! It's actually fairly common practice at Puppet to have spacing around headers, I was just being lazy in this case because I didn't think it was a big deal. I was wrong! Anyway, I'll at least try to look out for it until we come up with a way to maybe keep an eye on it. |
# 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.
I wasn't sure how to add tests for this to prevent future updates from breaking rendering. Someone would need to know to add blank lines around headers in the output fixtures if/when they are updated. I thought of adding a test that would read the fixture file and check the linespace padding, but if a new fixture is added (like one was recently), someone would also need to know to add a test against the new fixture. Testing the test fixture itself is not typical and didn't feel right.