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
GitHub is where the world builds software
Millions of developers and companies build, ship, and maintain their software on GitHub — the largest and most advanced development platform in the world.
x/website: Orientation about trailing dots in comments on the Effective Go website #40259
What did you do?
In your Effective Go website you set a standard of indeed using trailing dots by the end of comments on the "Commentary" section, as shown below:
But just above it, in the "Formatting" section, you write brief comments without dots by the end:
What is the then?
What did you expect to see?
A standardized way of writing comments in Go with regards to trailing dots.
What did you see instead?
Two different ways inside your Effective Go website.
As stated in Effective Go, doc comments (the first type you mention) work best as complete sentences, which implies a period at the end.
We make no recommendation for end-of-line comments (the second example you provide).
Since Effective Go is frozen at the point, we are unlikely to change this.
Our advice is to remain consistent with the code around you and/or follow your team’s style guides.