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

Section name of Header synopsis #6082

Open
hewillk opened this issue Feb 12, 2023 · 2 comments
Open

Section name of Header synopsis #6082

hewillk opened this issue Feb 12, 2023 · 2 comments

Comments

@hewillk
Copy link
Contributor

hewillk commented Feb 12, 2023

For "Header <meow> synopsis", the section name in the draft has three styles

  1. [xxx.syn]: Most common, such as [string.syn].
  2. [xxx.synop]: Rare, such as [any.synop].
  3. [xxx..synopsis]: Verbose, seems to only appear with [iterator.synopsis].

Is it worthwhile to unify the section names of all headers into the first style?
@JohelEGP
Copy link
Contributor

See #1958 (comment).

@jensmaurer
Copy link
Member

Additional note: xxx.syn can be auto-generated with simpler-to-use macros for references etc, thus is the preferred naming convention for new headers.

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
3 participants
@JohelEGP @jensmaurer @hewillk