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

Improve API documentation #50

Open
bplotnick opened this issue Jun 28, 2017 · 0 comments
Open

Improve API documentation #50

bplotnick opened this issue Jun 28, 2017 · 0 comments
Milestone

Comments

@bplotnick
Copy link
Contributor

The API has gotten sufficiently complicated due to our insistence on not breaking backwards compatibility. This has made it pretty difficult to reason about the different method arguments and their effect. Eventually, we're going to need a refactor, but for now a documentation update will have to suffice.

We started to do this in the Other utilities section of the readme, but we should fill it out with things like client vs server root spans, include annotation filter, 128-bit trace-id, etc.

@drolando drolando added this to the 1.0 milestone Jan 10, 2019
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

No branches or pull requests

2 participants