Conversation
timsong-cpp
reviewed
Sep 27, 2020
jensmaurer
reviewed
Sep 27, 2020
Member
There was a problem hiding this comment.
In general, we should move notes to outside of (even long) sentences. Regardless of punctuation and paragraph breaks, notes don't belong inside normative sentences. We should really try hard to move the notes (if all else fails, we might put the material into a footnote).
So, I'm opposed to merging this as-is unless we've exhausted the alternatives.
The new note* and example* environments will suppress the trailing paragraph break. This is useful when the environment is followed by a punctuation mark.
godbyk
force-pushed
the
feature/suppress-note-par
branch
from
September 27, 2020 21:02
3fc5b43 to
217df5a
Compare
Member
|
superseded by #4249 |
Contributor
Author
|
@jensmaurer You might evaluate the other two cases I found as well to see if they should be corrected in the same fashion. |
Member
|
We settled on "tailnote" and "tailexample". |
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
3 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.
The new
note*andexample*environments will suppress the trailing paragraph break. This is useful when the environment is followed by a punctuation mark.This PR addresses issue #4236.