New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Avoid \pnum inside examples. #1262
Conversation
With the exception of [facets.examples]. Fixes cplusplus#781.
|
||
\pnum | ||
\begin{example} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Consider here (and everywhere) whether the example illustrates the note or the section in general. (I'll take a look, too, but it's surprisingly hard to make GitHub show more context of the change.)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There a star-like thing on the upper left corner of each diff hunk that, when pressed, shows more context.
Anyway, I did consider for each change whether I should create a new numbered paragraph for an example or not, and I decided on an individual basis. For this particular case, the example clearly does not belong to the preceding note, and I figured a separate paragraph would be more appropriate.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, the star doesn't work well for interior changes :-S
OK, good, if this is all analyzed case-by-case, then I'm happy with it.
@@ -3918,14 +3918,12 @@ | |||
} | |||
\end{codeblock} | |||
|
|||
\pnum | |||
The \tcode{carries_dependency} attribute on function \tcode{f} means that the |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
(To be clear, these are still paragraph breaks, they're just not numbered. I'd like to call these "underhanded paragraphs". We do this in a few places.)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fully agreed. For this and a few other cases, I saw no way other than removing the number, but keeping the paragraph break.
With the exception of [facets.examples].
Fixes #781.