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

autoexport: Update docs #4132

Merged
merged 4 commits into from
Aug 3, 2023
Merged

Conversation

pellared
Copy link
Member

@pellared pellared commented Aug 2, 2023

Fixes #4102

Use Go doc comments.

Take notice that the package may support other kinds of exporters in future.

Testing

go install golang.org/x/pkgsite/cmd/pkgsite@latest
pkgsite

open: http://localhost:8080/go.opentelemetry.io/contrib/exporters/autoexport

@pellared
Copy link
Member Author

pellared commented Aug 2, 2023

This PR also explores if we could use regular Go Doc comments for documenting env vars. Similar PR: open-telemetry/opentelemetry-go#4336 CC @MadVikingGod

@pellared pellared marked this pull request as ready for review August 2, 2023 13:17
@pellared pellared requested a review from a team August 2, 2023 13:17
Copy link
Contributor

@MrAlias MrAlias left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚀

exporters/autoexport/doc.go Outdated Show resolved Hide resolved
Co-authored-by: Tyler Yahn <MrAlias@users.noreply.github.com>
@pellared pellared merged commit 83a3c26 into open-telemetry:main Aug 3, 2023
21 checks passed
@pellared pellared deleted the autoexport-docs branch August 3, 2023 12:55
@MrAlias MrAlias added this to the v0.43.0 milestone Aug 28, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

autoexport: Improve package documentation
3 participants