Skip to content

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

@bufdev

Description

@bufdev

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.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions