Skip to content

Make sure all packages have a godoc comment #69

@magnusbaeck

Description

@magnusbaeck

Description

Not all packages have a description, i.e. a "Package foo does this and that" godoc comment, but they should. Notably, the edition packages (editions/arica) are missing it but there might be others.

Motivation

A package description serves as a good introduction to the package. In the edition package case we could explain the purpose of the package and how it should be used as well as include a table with the (event type, version) pairs of the edition.

Exemplification

N/A

Benefits

See above.

Possible Drawbacks

None.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions