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

Subhead with no [stable.tag] #952

Closed
W-E-Brown opened this issue Oct 14, 2016 · 5 comments
Closed

Subhead with no [stable.tag] #952

W-E-Brown opened this issue Oct 14, 2016 · 5 comments

Comments

@W-E-Brown
Copy link
Contributor

Looking at N4604, clause [utility] (20.2), there's a subheading "Header <utility> synopsis" that has no [stable.tag].

  • Should it?
  • If so, a tag such as [utility.syn] seems consistent with similar synopsis subclauses.
@jwakely
Copy link
Member

jwakely commented Oct 14, 2016

That style of heading is created by the \synopsis command and I think the lack of tag is intentional (it doesn't start a new section). See also the <functional> synopsis in [function.objects], the <tuple> synopsis in [tuple.general], the <variant> synopsis in [variant.general] etc. etc.

@jwakely
Copy link
Member

jwakely commented Oct 14, 2016

[optional.syn] is inconsistent and doesn't use the \synopsis command:

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

Also [memory.syn]

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

And [meta.type.synop]:

\rSec2[meta.type.synop]{Header \tcode{<type_traits>} synopsis}

@tkoeppe
Copy link
Contributor

tkoeppe commented Oct 17, 2016

Use of \synopsis is optional. Lots of times we use real, numbered headings, exactly because getting a referenceable section name is useful. For the new C library synopses we tried sticking to a pattern by which the stable name for the synopsis of <cfoo> is [cfoo.syn].

@tkoeppe
Copy link
Contributor

tkoeppe commented Nov 18, 2016

See also Issue #566.

@jensmaurer
Copy link
Member

The original issue was fixed with #1213.

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

No branches or pull requests

4 participants