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
[lib] How to format sectioning comments in synopsis #802
Comments
I've been using the 3rd one (lowercase with colon), because as you noted, it is the most prevalent. |
I think we should be choosing between the second and third options. My preference is the second form, because the colon seems like noise to me (and I like the contents of the line after the comma to match the section name), but if consensus among editors is that the third is better, that's fine with me. |
On Sun, Jul 10, 2016 at 05:18:50PM -0700, Richard Smith wrote:
I've been using the 3rd option because that's the most common one. |
On Fri, Nov 18, 2016 at 11:17:02AM -0800, dawn@burble.org wrote:
I should add, that I really don't have a preference between 2 and 3, as |
Same here. Option 3 seems like the most prevalent one, so simplicity suggests we stick with that, but I'm also just as happy with 2 as with 3 in principle. |
I second @zygoloid here, the colon is adding nothing. |
I find the colon unnecessary too. |
Comments in a synopsis that refer to sections come in a variety of styles at the moment:
We should probably agree on a style. I think the third one is the most prevalent (lowercase with colon), though the second one is also widely used, and @zygoloid doesn't think the colon is helping any.
The text was updated successfully, but these errors were encountered: