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

Use godocs more effectively #725

Open
dashpole opened this issue Sep 26, 2023 · 0 comments
Open

Use godocs more effectively #725

dashpole opened this issue Sep 26, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request priority: p3

Comments

@dashpole
Copy link
Contributor

Many users of this repository will be used to the go-doc approach taken by opentelemetry-go: https://github.com/open-telemetry/opentelemetry-go/blob/main/CONTRIBUTING.md#documentation

We should try to follow this as well to provide a good experience. Concretely, this entails:

  • write example_test.go files to provide examples for all (or at least major) public functions
  • Use doc.go, rather than README.md files to document packages.
@dashpole dashpole added documentation Improvements or additions to documentation enhancement New feature or request priority: p2 labels Sep 26, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request priority: p3
Projects
None yet
Development

No branches or pull requests

2 participants