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

Minor styles inconsistency in single-line comments #1709

Closed
FrankHB opened this issue Aug 25, 2017 · 1 comment
Closed

Minor styles inconsistency in single-line comments #1709

FrankHB opened this issue Aug 25, 2017 · 1 comment
Assignees
@jensmaurer
Milestone
C++20 IS

Comments

@FrankHB
Copy link
Contributor

FrankHB commented Aug 25, 2017

Result of searching "// hash" shows...

[vector.syn]
// hash support
[unord.map.overview]
// hash policy:
[unord.set.overview]
// hash policy:
[unord.multimap.overview]
// hash policy
[unord.multiset.overview]
// hash policy:
[thread.thread.id]
// Hash support

Well, there are at least 2 problems.

  • Which case of letter should be used after //?
  • When to use trailing colon in a single-line comment?

Not sure if there has been already some rules about styles in comments, esp. in synopses. (Nonetheless, the examples above seem to be unintended.)
@tkoeppe
Copy link
Contributor

tkoeppe commented Sep 7, 2017

I think we agreed we usually want:

// \ref{...}, hash support

Additional punctuation was deemed unnecessary, as was capitalization.

@jensmaurer jensmaurer self-assigned this Oct 19, 2017
@jensmaurer jensmaurer added this to the C++20 milestone Oct 19, 2017
jensmaurer added a commit to jensmaurer/draft that referenced this issue Oct 19, 2017
@jensmaurer
[lib] Harmonize introductory comments in synopses
b2eeec5 
Even if no section reference is given, make them lowercase
and remove trailing colons.

Fixes cplusplus#1709.
@jensmaurer jensmaurer mentioned this issue Oct 19, 2017
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jensmaurer jensmaurer

Labels
None yet
Projects
None yet
Milestone
C++20 IS
Development

No branches or pull requests
3 participants
@FrankHB @tkoeppe @jensmaurer