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
[library] Use \effects etc. when referring to them in text #1093
Conversation
@@ -1592,15 +1592,15 @@ | |||
\begin{codeblock} | |||
#include <utility> | |||
|
|||
// Requires: \tcode{std::forward<T>(t)} shall be swappable with \tcode{std::forward<U>(u)}. | |||
// \requires \tcode{std::forward<T>(t)} shall be swappable with \tcode{std::forward<U>(u)}. |
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.
I wouldn't change these two comments. They're in an example, not in normative wording, and the status quo seems just fine.
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.
Agreed.
@@ -476,7 +476,7 @@ | |||
appropriate):\footnote{To save space, items that do not apply to a function are omitted. | |||
For example, if a function does not specify any | |||
further | |||
preconditions, there will be no ``Requires'' paragraph.} | |||
preconditions, there will be no \requires paragraph.} |
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.
Hm, we should probably also (but separately) decide one only one of paragraph, section or clause.
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.
I think section is best, because these can contain more than one paragraph, and my understanding is that clause and subclause have specific ISO meanings.
"element" is also used currently, but I think it sounds more vague than section.
But I agree that this can be done separately.
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.
"Element" is the term used when they are defined, and the term LWG has been using for them recently.
bf6b622
to
e4167fe
Compare
Fixes #1091.