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

Use godocs more effectively #725

Open

dashpole opened this issue Sep 26, 2023 · 0 comments

Labels

documentation enhancement priority: p3

Contributor

dashpole commented Sep 26, 2023

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 added documentation enhancement priority: p2 labels

dashpole mentioned this issue

Move metric example to example_test.go #727

Merged

aabmass added priority: p3 and removed priority: p2 labels

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment