Join GitHub today
GitHub is home to over 50 million developers working together to host and review code, manage projects, and build software together.Sign up
go/doc: lines ending with parenthesis cannot be headings #34377
What did you do?
What did you expect to see?
What did you see instead?
Thank you for reporting.
The implementation contains a rule that a heading "must end in a letter or digit", which is preventing a heading that ends with ')' to become a title. See:
That rule isn't mentioned in the
We needed some way to distinguish a headline from a simple sentence.
Proper documentation fixes only half of the problem. We could allow
While I dislike markup in code comments I think the rules for a good heading