Skip to content
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

Merged
merged 1 commit into from Dec 16, 2016
Merged

Avoid \pnum inside examples. #1262

merged 1 commit into from Dec 16, 2016

Conversation

jensmaurer
Copy link
Member

With the exception of [facets.examples].

Fixes #781.

With the exception of [facets.examples].

Fixes cplusplus#781.

\pnum
\begin{example}
Copy link
Contributor

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.)

Copy link
Member Author

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.

Copy link
Contributor

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
Copy link
Contributor

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.)

Copy link
Member Author

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.

@tkoeppe tkoeppe merged commit a3afbc8 into cplusplus:master Dec 16, 2016
@jensmaurer jensmaurer deleted the b17 branch December 18, 2016 19:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants