[lib] Replace 'Notes:' elements with regular [ Note: ... -- end note] #1160
Conversation
|
Looks good, but I'll let @zygoloid handle it, since it's a fairly substantial change. |
| Notes: the algorithm | ||
| \tcode{equal()} | ||
| \begin{note} | ||
| The algorithm \tcode{equal()} | ||
| is defined in Clause~\ref{algorithms}. | ||
| Those entries marked ``(Note A)'' or ``(Note B)'' |
There was a problem hiding this comment.
This second sentence is normative, and should not be within the note.
| @@ -3236,9 +3237,11 @@ | |||
| \throws Nothing unless one of the element-wise swap calls throws an exception. | |||
|
|
|||
| \pnum | |||
| \realnote Unlike the \tcode{swap} function for other containers, \tcode{array::swap} | |||
| \begin{note} | |||
| Unlike the \tcode{swap} function for other containers, \tcode{array::swap} | |||
| takes linear time, may exit via an exception, and does not cause iterators to | |||
| become associated with the other container. | |||
There was a problem hiding this comment.
Where are these properties normatively stated?
There was a problem hiding this comment.
All I have is Note A and Note B in [container.requirements.general] after the table.
Suggestion: This says "As if by swap_ranges" for the effects. Let's change that to "Equivalent to" and we get all the missing pieces for free, and can leave the note as a note.
There was a problem hiding this comment.
(The updated version adds the "Equivalent to" a few lines earlier.)
| must be taken to ensure that this does not cause deadlock due to lock | ||
| ordering issues. After calling \tcode{notify_all_at_thread_exit} it is | ||
| recommended that the thread should be exited as soon as possible, and | ||
| that no blocking or time-consuming tasks are run on that thread. | ||
|
|
||
| \pnum | ||
| \realnote It is the user's responsibility to ensure that waiting threads |
There was a problem hiding this comment.
Use two separate notes here? Generally I'd like to avoid \pnums within a note.
| If any of the \tcode{wait} functions exits via an exception, it is | ||
| unspecified whether the \tcode{Lock} is held. One can use a \tcode{Lock} type | ||
| that allows to query that, such as the \tcode{unique_lock} wrapper. | ||
| \end{note} |
There was a problem hiding this comment.
I'm not entirely comfortable positioning this between the notify* functions and the wait* functions -- it seems pretty easy to miss here.
There was a problem hiding this comment.
Ok, reverted to the previous position.
| the return type and return value of the member function \tcode{get}. | ||
|
|
||
| \pnum | ||
| \realnote access to a value object stored in the shared state is |
There was a problem hiding this comment.
Again, please avoid the \pnum within a note here.
Remove the \realnotes and \realnote macros. No longer mention 'Notes:' in [structure.specifications]. Fixes cplusplus#492.
|
Updated. |
Remove the \realnotes and \realnote macros.
No longer mention 'Notes:' in [structure.specifications].
Fixes #492.