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.

Sign up for GitHub

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

Jump to bottom

Package Documentation #140

Open
dave-tucker opened this issue May 27, 2021 · 0 comments
Open

Package Documentation #140

dave-tucker opened this issue May 27, 2021 · 0 comments
Labels
feature good first issue

Comments

@dave-tucker
Copy link
Collaborator

We have some documentation, but it's not extensive.
We should ensure that:

  1. All packages have a doc.go
  2. All functions that are part of the package API have good documentation
  3. Function comments can avoid mentioning types (e.g does foo with a model.Model) as links are already populated in the godoc.
  4. Examples should be in a doc_test.go file see. This ensures that they compile and won't be forgotten with API changes
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
feature good first issue
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@dave-tucker