`add_attachment` needs to be called from the top level API from version 3.0 on
Nobody has claimed this yet.
Assessment
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Newbie friendliness
- 78/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Stale
- Tech stack
- python
- Domain
- documentation
Research direction
Open the attachments page at https://docs.sentry.io/platforms/python/enriching-events/attachments/ and review the current add_attachment guidance. Update it to distinguish Python SDK versions below 3.0 from version 3.0 onward, including the documented top-level sentry_sdk.add_attachment() API. Done means the page clearly states which call location applies to each version.
Written by the indexing model from the issue text.
Description
SDK
Python SDK
Description
The API add_attachment is documented to be called on the Scope. From version 3.0 of the Python SDK on it should always be called from the top level API sentry_sdk.add_attachment().
Suggested Solution
Update this page: https://docs.sentry.io/platforms/python/enriching-events/attachments/
In SDK <3.0 it can be called only from the Scope. (like described now. Maybe we also add the top level API in a minor, then both ways should be described)
In SDK >=3.0 it should be called only from the top level API sentry_sdk.add_attachment()
- Dominant language
- MDX
- Stars
- 446
- Forks
- 1.7k
- Avg merge
- 1d 21h
- Merged PRs (30d)
- 312
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from getsentry/sentry-docs
-
Docs Platform: Android SDKs
Difficulty 1/5 Under an hour Newbie friendliness 95/100
getsentry/sentry-docs#19438 · 1 comment ·
-
Docs Platform: Python SDKs
Difficulty 1/5 Under an hour Newbie friendliness 92/100
getsentry/sentry-docs#19432 · 2 comments ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
getsentry/sentry-docs#19347 · 1 comment ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
getsentry/sentry-docs#19182 · 1 comment ·
-
Docs Good First Issue Platform: PHP SDKs
Difficulty 1/5 Under an hour Newbie friendliness 90/100
getsentry/sentry-docs#19177 · 2 comments ·
All issues in getsentry/sentry-docs
Similar issues
-
user-reported
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
Kong/developer.konghq.com#7316 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
HarperFast/skills#96 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
infinispan/infinispan#18150 ·
-
bug triage:deciding
Difficulty 1/5 Under an hour Newbie friendliness 88/100
open-telemetry/otel-arrow#4132 ·
-
Ecosystem: ClawMetry — the Qwen Code reader is now free and open source (follow-up to #9294 / #9338) Opencategory/integration priority/P3 scope/documentation status/ready-for-human type/feature-request
Difficulty 1/5 Under an hour Newbie friendliness 84/100