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

Synopses should have numbered headers #566

Closed
tkoeppe opened this issue Nov 20, 2015 · 2 comments
Closed

Synopses should have numbered headers #566

tkoeppe opened this issue Nov 20, 2015 · 2 comments

Comments

@tkoeppe
Copy link
Contributor

tkoeppe commented Nov 20, 2015

Following PR 560, @zygoloid noticed that there are still several synopses that don't have numbered headers (e.g. strings, algorithms). Uses of \synopsis should be replaced with:

\rSec2[foo.syn]{Header \tcode{<foo>} synopsis}

See also #542.
@tkoeppe
Copy link
Contributor Author

tkoeppe commented Nov 20, 2015

Question: Should all synopses appear at the top-most level, as a sibling to "General", as we currently do with the containers library? Or is it appropriate to keep them within their respective subsections (and use rSec3)?

For example, consider [diagnostics]. We could either list the synopses of <stdexcept> and <system_error> at the top, right after "General", as the new 19.2, or we could keep them in their current place as 19.2.1 and 19.5.1.

I'm mildly in favour of the latter approach, since we'd otherwise be left with text that wouldn't have a section any more (such as the text after the <system_error> synopsis at the moment).

@tkoeppe tkoeppe mentioned this issue Nov 20, 2015
Merged
@tkoeppe
Copy link
Contributor Author

tkoeppe commented Nov 18, 2016

@tkoeppe: Ping. What should we do with all the remaining \synopsiss?

@tkoeppe tkoeppe mentioned this issue Nov 18, 2016
Closed
tkoeppe added a commit that referenced this issue Nov 29, 2016
@tkoeppe
[tuple, variant] Turn synopses into numbered subclauses
30e5547 
In pursuit of issue #566.
tkoeppe added a commit that referenced this issue Nov 29, 2016
@tkoeppe
[string.classes] Turn <string> synopsis into numbered subclause
c58e854 
In pursuit of issue #566.
@tkoeppe tkoeppe mentioned this issue Dec 7, 2016
Merged
jensmaurer added a commit to jensmaurer/draft that referenced this issue Dec 12, 2016
@jensmaurer
[bitset] Introduce a separate heading for the synopsis.
de687c6 
Partially addresses cplusplus#566.
@jensmaurer jensmaurer mentioned this issue Dec 12, 2016
Merged
jensmaurer added a commit to jensmaurer/draft that referenced this issue Dec 12, 2016
@jensmaurer
[thread] Add numbered headings for synopses.
2fb8b0f 
Partially addresses cplusplus#566.
@jensmaurer jensmaurer mentioned this issue Dec 12, 2016
Merged
tkoeppe pushed a commit that referenced this issue Dec 12, 2016
@jensmaurer @tkoeppe
[thread] Add numbered headings for synopses. (#1214)
bc42416 
Partially addresses #566.
jensmaurer added a commit to jensmaurer/draft that referenced this issue Dec 13, 2016
@jensmaurer
[utility], [bitset] Introduce a separate heading for the synopsis.
f00ce50 
Partially addresses cplusplus#566.
tkoeppe pushed a commit that referenced this issue Dec 13, 2016
@jensmaurer @tkoeppe
[utility], [bitset] Introduce a separate heading for the synopsis. (#…
aefc83c 
…1213)

Partially addresses #566.
@jensmaurer jensmaurer mentioned this issue Dec 13, 2016
Merged
jensmaurer added a commit to jensmaurer/draft that referenced this issue Dec 13, 2016
@jensmaurer
[input.output] Add numbered headings for synopses.
8d840f7 
Remove now-empty 'Overview' sections.

Partially addresses cplusplus#566.
@jensmaurer jensmaurer mentioned this issue Dec 13, 2016
Merged
tkoeppe pushed a commit that referenced this issue Dec 13, 2016
@jensmaurer @tkoeppe
[input.output] Add numbered headings for synopses. (#1228)
e6b9e31 
Remove now-empty 'Overview' sections.

Partially addresses #566.
jensmaurer added a commit to jensmaurer/draft that referenced this issue Dec 13, 2016
@jensmaurer
[localization] Add numbered headings for synopses.
f5d6cca 
Partially addresses cplusplus#566.
jensmaurer added a commit to jensmaurer/draft that referenced this issue Dec 13, 2016
@jensmaurer
[localization] Add numbered headings for synopses.
a6a0909 
Partially addresses cplusplus#566.
@jensmaurer jensmaurer mentioned this issue Dec 13, 2016
Merged
jensmaurer added a commit to jensmaurer/draft that referenced this issue Dec 13, 2016
@jensmaurer
[algorithms] Add numbered heading for synopsis.
ec5547c 
Partially addresses cplusplus#566.
@jensmaurer jensmaurer mentioned this issue Dec 13, 2016
Merged
tkoeppe pushed a commit that referenced this issue Dec 13, 2016
@jensmaurer @tkoeppe
[algorithms] Add numbered heading for synopsis. (#1230)
93ccb07 
Partially addresses #566.
jensmaurer added a commit to jensmaurer/draft that referenced this issue Dec 13, 2016
@jensmaurer
[localization] Add numbered headings for synopses.
85f934c 
Also remove use of \synopsis for class template definitions.

Partially addresses cplusplus#566.
tkoeppe pushed a commit that referenced this issue Dec 13, 2016
@jensmaurer @tkoeppe
[localization] Add numbered headings for synopses. (#1229)
9363169 
Also remove use of \synopsis for class template definitions.

Partially addresses #566.
jensmaurer added a commit to jensmaurer/draft that referenced this issue Dec 14, 2016
@jensmaurer
Remove \synopsis macro.
23e6881 
[res.on.functions] Do not use \synopsis for emphasis.

Fixes cplusplus#566.
@jensmaurer jensmaurer mentioned this issue Dec 14, 2016
Merged
tkoeppe pushed a commit that referenced this issue Dec 14, 2016
@jensmaurer @tkoeppe
Remove \synopsis macro. (#1231)
40271f6 
[res.on.functions] Do not use \synopsis for emphasis.

Fixes #566.
@jensmaurer jensmaurer mentioned this issue Dec 14, 2016
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@tkoeppe