[path.non-member] Structure multi-paragraph note using an itemization instead. #1236
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
tkoeppe
reviewed
Dec 14, 2016
| @@ -11944,15 +11944,17 @@ | |||
| \pnum | |||
| \begin{note} Path equality and path equivalence have different semantics. | |||
|
|
|||
There was a problem hiding this comment.
Lose the newlines surrounding the itemize environment.
|
I like it! I haven't even got to iostreams yet. I have no doubt that there will be a plethora of editorial improvements we'll make to the new parts of it. |
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.
Diff:
This removes the most egregious instance in the document of a note spanning multiple numbered paragraphs, and I think it actually reads and looks nicer as an itemization (and with the examples marked as examples).
Thoughts? :)