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

Comments on packages and public types should be GoDoc friendly #97

Closed
bufdev opened this issue Dec 16, 2015 · 2 comments
Closed

Comments on packages and public types should be GoDoc friendly #97

bufdev opened this issue Dec 16, 2015 · 2 comments

Comments

@bufdev
Copy link
Contributor

bufdev commented Dec 16, 2015

Package comments always start with "Package name_of_package ...", types are always commented wit the name of the type:

// Foo is a ...
type Foo struct {
}

// Bar does ...
type Bar interface {
}

var (
  // Name is the volume driver name.
  //
  // TODO(osd team): more descriptive names for these variables  
  Name = "btrfs"
)

This will fail golint otherwise.

@jvinod
Copy link
Contributor

jvinod commented Dec 17, 2015

+1 and will enforce going forward.

@erickhan erickhan added this to the v1.3 milestone Mar 8, 2017
@lpabon
Copy link
Member

lpabon commented Nov 13, 2017

Closing since it has had no update for more than 6 months. Please reopen if needed.

@lpabon lpabon closed this as completed Nov 13, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants