docs(attachment): Document attachment parameters #3342
Merged
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
|
Test Failures Detected: Due to failing tests, we cannot provide coverage reports at this time. ❌ Failed Test Results:Completed 12464 tests with View the full list of failed testspy3.9-aws_lambda
|
szokeasaurusrex
force-pushed
the
szokeasaurusrex/attachment-docs
branch
2 times, most recently
from
1700596 to
bd917b6
Compare
Update the type hint to clarify that `add_attachment`'s `bytes` parameter can also accept `Callable[[], bytes]` values, since it gets passed through to the `Attachment` constructor, which accepts such values.
Document parameters to `sentry_sdk.Scope.add_attachment` and `sentry_sdk.attachments.Attachment`. Fixes: #3340 Related: getsentry/sentry-docs#10844
szokeasaurusrex
force-pushed
the
szokeasaurusrex/attachment-docs
branch
from
bd917b6 to
088589a
Compare
sl0thentr0py
approved these changes
Jul 25, 2024
szokeasaurusrex
added a commit
to getsentry/sentry-docs
that referenced
this pull request
Jul 25, 2024
Update attachment docs to reflect new API added in Python SDK 2.0.0, and introduce other general improvements to the page. Depends on getsentry/sentry-python#3342, which adds parameter documentation to the API Docs. Fixes: #10844 Related: getsentry/sentry-python#3340
6 tasks
arjennienhuis
pushed a commit
to arjennienhuis/sentry-python
that referenced
this pull request
Sep 30, 2024
Update the type hint to clarify that `add_attachment`'s `bytes` parameter can also accept `Callable[[], bytes]` values, since it gets passed through to the `Attachment` constructor, which accepts such values.
arjennienhuis
pushed a commit
to arjennienhuis/sentry-python
that referenced
this pull request
Sep 30, 2024
Document parameters to `sentry_sdk.Scope.add_attachment` and `sentry_sdk.attachments.Attachment`. Fixes: getsentry#3340 Related: getsentry/sentry-docs#10844
# for free
to join this conversation on GitHub.
Already have an account?
# 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.
Document parameters to
sentry_sdk.Scope.add_attachmentandsentry_sdk.attachments.Attachment.Also, update
add_attachment's type hint to match theAttachmentconstructor's hint.Fixes: #3340
Related: getsentry/sentry-docs#10844