doc: make the style of notes consistent - #13133
Closed
aqrln wants to merge 3 commits into
Closed
Conversation
Loading
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
11 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.
Make the style of "Note:" paragraphs consistent and document the guidelines in
doc/STYLE_GUIDE.md.Fixes: #13131
I picked the style that I find reasonable and which I had used once adding a note myself, but I don't have any strong opinions about the notes style except that it should be only one, so the formatting may be discussed in this PR.
Checklist
Affected core subsystem(s)
doc