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.

Sign up for GitHub

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

Jump to bottom

Get rid of Notes: elements in library clauses #492

Closed
jwakely opened this issue May 5, 2015 · 1 comment
Closed

Get rid of Notes: elements in library clauses #492

jwakely opened this issue May 5, 2015 · 1 comment
Assignees
@jwakely @jensmaurer

Comments

@jwakely
Copy link
Member

jwakely commented May 5, 2015

17.5.1.4 [structure.specifications] defines what a Notes: element means in the detailed specification for a function.

The only correct use of this in the entire standard is 20.12.5.7 [time.duration.cast] (which is missing a paragraph number! it should be paragraph 3).

23.2.1 [container.requirements.general] p4 has a "Notes:" following table 96 but it's not the same thing, because it's not italicized, and isn't a detailed specification where [structure.specifications] applies (so just seems wrong to me, maybe it should be "[Note: the algorithm equal() is defined in Clause 25.]"

Daniel added:

There exits some incorrectly spelled "Notes:" written as "Note:" such
as in 20.4.2.4p13, [tuple.elem] p4, [unique.ptr.single.observers] p5
and maybe elsewhere, but I don't really like this additional flavour
of notes and would happily replace them all by our usual [Note: - end
note]
@jwakely jwakely self-assigned this May 5, 2015
@jensmaurer jensmaurer self-assigned this Dec 1, 2016
@jensmaurer
Copy link
Member

With the Parallelism TS merged, we now have a few more Notes: items. I'll prepare a patch to replace all of them with the regular "[ Note: ... -- end note ]" phrasing.

jensmaurer added a commit to jensmaurer/draft that referenced this issue Dec 1, 2016
@jensmaurer
[lib] Replace 'Notes:' elements with regular [ Note: ... -- end note]
4f63b2c 
Remove the \realnotes and \realnote macros.
No longer mention 'Notes:' in [structure.specifications].

Fixes cplusplus#492.
@jensmaurer jensmaurer mentioned this issue Dec 1, 2016
Merged
jensmaurer added a commit to jensmaurer/draft that referenced this issue Dec 14, 2016
@jensmaurer
[lib] Replace 'Notes:' elements with regular [ Note: ... -- end note]
2ccda48 
Remove the \realnotes and \realnote macros.
No longer mention 'Notes:' in [structure.specifications].

Fixes cplusplus#492.
jensmaurer added a commit to jensmaurer/draft that referenced this issue Dec 14, 2016
@jensmaurer
[lib] Replace 'Notes:' elements with regular [ Note: ... -- end note]
c886169 
Remove the \realnotes and \realnote macros.
No longer mention 'Notes:' in [structure.specifications].

Fixes cplusplus#492.
zygoloid pushed a commit that referenced this issue Feb 4, 2017
@jensmaurer @zygoloid
[lib] Replace 'Notes:' elements with regular [ Note: ... -- end note] (…
23d7399 
…#1160)

Remove the \realnotes and \realnote macros.
No longer mention 'Notes:' in [structure.specifications].

Fixes #492.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jwakely jwakely

@jensmaurer jensmaurer

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@jwakely @jensmaurer