Skip to content

SPDX headers incorrectly interpreted as package documentation #156

@jhoward-lm

Description

@jhoward-lm

The SPDX header comment block is being interpreted as package documentation in the generated godoc pages (example)

  • Add blank line before each package declaration
  • In cases where package godoc is desired, a common convention is to create a file called doc.go in the package with nothing but the package declaration and doc comment (example)

Metadata

Metadata

Assignees

Labels

bugSomething isn't workingdocumentationImprovements or additions to documentation

Type

No type

Projects

Status

Done

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions