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

docs(python): Update attachment docs for 2.x #10851

Merged
merged 3 commits into from
Sep 6, 2024

Conversation

szokeasaurusrex
Copy link
Member

@szokeasaurusrex szokeasaurusrex commented Jul 25, 2024

DESCRIBE YOUR PR

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

IS YOUR CHANGE URGENT?

Help us prioritize incoming PRs by letting us know when the change needs to go live.

  • Urgent deadline (GA date, etc.):
  • Other deadline:
  • None: Not urgent, can wait up to 1 week+

PRE-MERGE CHECKLIST

Make sure you've checked the following before merging your changes:

  • Checked Vercel preview for correctness, including links
  • PR was reviewed and approved by any necessary SMEs (subject matter experts)
  • PR was reviewed and approved by a member of the Sentry docs team

@szokeasaurusrex szokeasaurusrex requested review from sl0thentr0py and a team July 25, 2024 12:31
Copy link

vercel bot commented Jul 25, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
changelog ✅ Ready (Inspect) Visit Preview 💬 Add feedback Sep 6, 2024 2:05pm
sentry-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Sep 6, 2024 2:05pm
1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
develop-docs ⬜️ Ignored (Inspect) Visit Preview Sep 6, 2024 2:05pm

Copy link

codecov bot commented Jul 25, 2024

Bundle Report

Changes will decrease total bundle size by 15 bytes ⬇️

Bundle name Size Change
sentry-docs-server 8.26MB 6 bytes ⬇️
sentry-docs-edge-server 254.34kB 3 bytes ⬇️
sentry-docs-client 6.26MB 6 bytes ⬇️

Copy link
Member

@sl0thentr0py sl0thentr0py left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ty!

@szokeasaurusrex
Copy link
Member Author

Hello, could we please get a @getsentry/docs review here? Thanks in advance.

Copy link
Contributor

@lizokm lizokm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A small wording suggestion, otherwise this looks great. Thanks for updating!

szokeasaurusrex and others added 2 commits August 27, 2024 14:57
Update attachment docs to reflect new API added in Python SDK 2.0.0,
and introduce other general improvements to the page.

Fixes: #10844
Related: getsentry/sentry-python#3340
Co-authored-by: Liza Mock <liza.mock@sentry.io>
@antonpirker antonpirker deleted the szokeasaurusrex/python-attachment-docs branch September 6, 2024 14:05
@github-actions github-actions bot locked and limited conversation to collaborators Sep 22, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Fix python attachments docs for 2.x
5 participants