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

inconsistently including or omitting comma between "// x.y.z" and rest of comment in synopses #403

Closed
zygoloid opened this issue Nov 15, 2014 · 4 comments

Comments

@zygoloid
Copy link
Member

See for instance 20.8.1.2

// 20.8.1.2.4, observers
// 20.8.1.2.5 modifiers

... but this inconsistency occurs in lots of places. We should pick one style and stick to it.

@jensmaurer
Copy link
Member

So, which one do you pick?

@tkoeppe
Copy link
Contributor

tkoeppe commented Nov 13, 2016

I'd prefer the style

// 1.2.3, description:

I believe that's a widely used style in the library.

@jensmaurer
Copy link
Member

Richard?

@jensmaurer jensmaurer added the decision-required A decision of the editorial group (or the Project Editor) is required. label Nov 13, 2016
@jensmaurer
Copy link
Member

Duplicate of #802.

@jensmaurer jensmaurer removed the decision-required A decision of the editorial group (or the Project Editor) is required. label Nov 23, 2016
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

3 participants