[diff] Uniform style for examples #5757
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
For C++ differences, examples are always preceded by the phrase "For example:", do not use the usual [Example n: ... -- end example] style, and always appear in the "Effects on original feature" paragraph. For differences with C, a different set of styles is used (examples being part of paragraphs such as "Change" and "Rationale"), and that subclause remains unchanged by this commit.
JohelEGP
suggested changes
Aug 20, 2022
Co-authored-by: Johel Ernesto Guerrero Peña <johelegp@gmail.com>
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.
For C++ differences, examples are always preceded by the phrase "For
example:", do not use the usual [Example n: ... -- end example] style,
and always appear in the "Effects on original feature" paragraph.
For differences with C, a different set of styles is used (examples
being part of paragraphs such as "Change" and "Rationale"), and that
subclause remains unchanged by this commit.
Suggested by CD review.
I will update the wiki accordingly.