docs: Fix trailing many '+' and delimit note blocks.#4039
Closed
BsAtHome wants to merge 1 commit into
Closed
Conversation
Collaborator
|
I dont want this. I like my docs as they were. If there were warnings on a couple lines I will look at those, but please don't reformat my docs. |
Contributor
Author
|
Forced line breaks are inappropriate formatting and actually break proper formatting when floating formatting is used (like in a browser). However, you want it, you do it and I'll refrain from looking at your the docs. |
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
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.
Remove most trailing '+' to force line breaks. Hard line breaks are mostly inappropriate and it should be left to paragraph formatting.
When using hard breaks in lists, then the line after the break must be indented or a warning will be issued. This was the actual cause of the messages identified in #4038.
The change caused some note/important/caution blocks to be slightly off because they were not delimited and relied on empty line delimit. These are now properly delimited so that blocks are actually identified as blocks.
This fixes #4038.