docs: unify format of notes #17294
Merged
docs: unify format of notes #17294
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
added 2 commits
February 12, 2023 19:36
`NB`, `Note`, `Please note` replaced with `> Node:`
added 2 commits
February 12, 2023 19:58
i582
added
the
Unit: Documentation
i582
force-pushed
the
pmakhnev/unify_notes
branch
from
71613f4
to
dfd0979
Compare
added 7 commits
February 12, 2023 20:26
spytheman
reviewed
Feb 13, 2023
Comment on lines
-149
to
+153
| **Important Note:** *Consecutive dots, for example `...`, are not allowed.* | ||
| *This will cause a syntax error. Use a quantifier instead.* | ||
| > Important Note: Consecutive dots, for example `...`, are not allowed. | ||
| > This will cause a syntax error. Use a quantifier instead. |
There was a problem hiding this comment.
The previous wording/formatting here was more distinct imho.
spytheman
approved these changes
Feb 13, 2023
l1mey112
pushed a commit
to l1mey112/v
that referenced
this pull request
Jun 7, 2023
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.
NB,N.B.,Note,NOTE,Please notereplaced with**Note**One common standard allows the reader to better navigate the material.
Also "Note" is more understandable to non-native speakers than "NB".
Highlighting each note as a quote also makes it easier to notice them than if they are written in the same style as other text.
Example:
See also: community/community#16925