ref(tracing): Pre-traces_sampler documentation additions
#865
Conversation
This file contains 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
flub
approved these changes
Oct 16, 2020
sentry_sdk/tracing.py
Outdated
|
|
||
| If the 'sentry-trace' header is malformed or missing, just create and | ||
| return a Transaction instance with the given params. | ||
| """ | ||
| # type: (...) -> Transaction |
There was a problem hiding this comment.
The linter doesn't seem to like this order of type comment after the docstring?
There was a problem hiding this comment.
Oh, that's what it was mad about! The problematic ordering predates me, so I figured it was just the linter not being 100% on board with type hints. Fixed now, thanks.
There was a problem hiding this comment.
Ugh. After a lot of poking, I figured out what the problem is: mypy wants the type annotations before the docstring, whereas pylance (the VSCode Python engine) very much wants them after. So now my editor is all kinds of mad, but at least CI is passing.
This was referenced Oct 16, 2020
lobsterkatie
force-pushed
the
kmclb-pre-traces-sampler-comments
branch
from
fdb9a3e
to
95e0383
Compare
lobsterkatie
force-pushed
the
kmclb-pre-traces-sampler-comments
branch
from
cbd6ff1
to
bf5977e
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
A bunch of comments and docstrings which got added while I was working on #863. Also adds data to both the
SpanandTransactionreprs, and changes a handful of variable names to be more accurate. No behavior changes.