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

[support, diagnostics] Turn synopses into numbered sections #569

Merged
merged 3 commits into from Nov 23, 2015

Conversation

tkoeppe
Copy link
Contributor

@tkoeppe tkoeppe commented Nov 20, 2015

This is the first careful approach towards Issue #566. The transformation of \synopsis to rSec2 seems particularly straight-forward in these clauses.

This change introduces the following new stable names (all of which are unique):

[support]:

  • new.syn
  • type.info.syn
  • exception.syn
  • support.initlist.syn

[diagnostics]:

  • std.exceptions.syn
  • syserr.syn

@tkoeppe tkoeppe changed the title [support] Turn synopses into numbered sections [support, diagnostics] Turn synopses into numbered sections Nov 21, 2015
@zygoloid
Copy link
Member

Hmm, what do you think about consistently naming these synopsis sections after the header? ([stdexcept.syn], [system_error.syn], ...).

We're currently inconsistent on this; some are named [surrounding_clause.syn] and some are named [header_name.syn], but in most cases those two names are in fact the same. For instance, we have [time.syn] for and [re.syn] for , and conversely we have [locale.syn] nested within [localization], and [valarray.syn] nested with [numarray]. But naming the synopsis subclauses after their headers seems both more stable and more useful than naming them after the surrounding clause.

@tkoeppe
Copy link
Contributor Author

tkoeppe commented Nov 23, 2015

That seems reasonable. I have no strong preference, I was just trying to blend in as much as possible.

I'll rename the stable names.

@tkoeppe
Copy link
Contributor Author

tkoeppe commented Nov 23, 2015

Reworded; new stable names are now:

[support]:

  • new.syn
  • typeinfo.syn
  • exception.syn
  • initializer_list.syn

[diagnostics]:

  • stdexcept.syn
  • system_error.syn

@zygoloid
Copy link
Member

Please rerun makexref to regenerate Annex F. Otherwise, this looks good to me.

@tkoeppe
Copy link
Contributor Author

tkoeppe commented Nov 23, 2015

Done.

zygoloid added a commit that referenced this pull request Nov 23, 2015
[support], [diagnostics] Turn synopses into numbered sections
@zygoloid zygoloid merged commit 3ee5ff4 into cplusplus:master Nov 23, 2015
@sigfpe
Copy link

sigfpe commented Nov 23, 2015

Sounds like a great suggestion to me.-------- Original message --------From: Richard Smith notifications@github.com Date: 11/23/2015 11:59 AM (GMT-08:00) To: cplusplus/draft draft@noreply.github.com Subject: Re: [draft] [support, diagnostics] Turn synopses into numbered
sections (#569)
Hmm, what do you think about consistently naming these synopsis sections after the header? ([stdexcept.syn], [system_error.syn], ...).

We're currently inconsistent on this; some are named [surrounding_clause.syn] and some are named [header_name.syn], but in most cases those two names are in fact the same. For instance, we have [time.syn] for and [re.syn] for , and conversely we have [locale.syn] nested within [localization], and [valarray.syn] nested with [numarray]. But naming the synopsis subclauses after their headers seems both more stable and more useful than naming them after the surrounding clause.


Reply to this email directly or view it on GitHub.

@tkoeppe tkoeppe deleted the syn branch November 23, 2015 21:13
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

Successfully merging this pull request may close these issues.

None yet

3 participants