docs: updating trace API docstrings#1170
Merged
codeboten merged 2 commits intoopen-telemetry:masterfrom Sep 30, 2020
Merged
Conversation
The current docstrings were not factually correct, and different wording provided better clarity: - start_as_current_span shoudl return the current span back to the previous current span in the context, rather than the parent span. This is the behavior of the SDK. - There is not "tracer context", simply the "context" object. So renaming references there.
lzchen
reviewed
Sep 29, 2020
| parent can also be specified, either a `Span` or a `opentelemetry.trace.SpanContext`. If | ||
| the specified value is `None`, the created span will be a root span. | ||
| By default the current span in the context will be used as parent, but an | ||
| explicit parent can also be specified, either a `Span` or a `opentelemetry.trace.SpanContext`. |
Contributor
There was a problem hiding this comment.
FYI: I think this won't be the case after this change but we can probably update the docs afterwards to reflect this.
Contributor
There was a problem hiding this comment.
Good point, I'll make sure to update it in that change.
lzchen
approved these changes
Sep 29, 2020
codeboten
approved these changes
Sep 30, 2020
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The current docstrings were not factually correct, and different
wording provided better clarity:
to the previous current span in the context, rather than the
parent span. This is the behavior of the SDK.
renaming references there.
See open-telemetry/opentelemetry-specification#1011 (comment)
Type of change
Please delete options that are not relevant.
Checklist: