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

Make sure all packages have a godoc comment #69

Open
magnusbaeck opened this issue Jul 29, 2023 · 0 comments
Open

Make sure all packages have a godoc comment #69

magnusbaeck opened this issue Jul 29, 2023 · 0 comments
Labels
enhancement New feature or request

Comments

@magnusbaeck
Copy link
Member

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.

@magnusbaeck magnusbaeck added the enhancement New feature or request label Jul 29, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant