Skip to content

x/website: Orientation about trailing dots in comments on the Effective Go website #40259

@rogerlucena

Description

@rogerlucena

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:

// Compile parses a regular expression and returns, if successful,
// a Regexp that can be used to match against text.
func Compile(str string) (*Regexp, error) {

But just above it, in the "Formatting" section, you write brief comments without dots by the end:

type T struct {
    name string // name of the object
    value int // its value
}

What is the Go readability standard 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.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions