Skip to content

Conversation

alexander-alderman-webb
Copy link
Contributor

@alexander-alderman-webb alexander-alderman-webb commented Sep 30, 2025

DESCRIBE YOUR PR

Generic references or plural references to SDKa are confusing in the platform docs. The reader expects us to describe the behavior of the Python SDK, and not make vague statements about how it may work.

Closes #15062

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+

SLA

  • Teamwork makes the dream work, so please add a reviewer to your PRs.
  • Please give the docs team up to 1 week to review your PR unless you've added an urgent due date to it.
    Thanks in advance for your help!

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

LEGAL BOILERPLATE

Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. and is gonna need some rights from me in order to utilize my contributions in this here PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms.

EXTRA RESOURCES


Note

Refines Python docs to be Python-SDK specific and clarifies options/hooks, adding details for shutdown draining (close/flush), breadcrumb hints/automation, filtering/sampling, and PII handling.

  • Python SDK specificity:
    • Replace generic “SDKs” language with Python-SDK specific phrasing across configuration, filtering, sampling, sessions, usage, and sensitive data pages.
  • Shutdown & draining (configuration/draining*.mdx):
    • Clarify background sending; document client.close() behavior (disables client) and flush alternative.
  • Filtering & hooks (configuration/filtering, options.mdx):
    • Clarify before_send, before_send_transaction, before_breadcrumb, and before_send_log semantics and hints usage.
    • Tighten transport and shutdown_timeout descriptions.
  • Sampling (configuration/sampling.mdx):
    • Clarify sampling-context description (integration-based) and examples.
  • Sensitive data (data-management/sensitive-data) :
    • Emphasize default non-PII behavior, SDK-level scrubbing options, and where sensitive data may appear.
  • Breadcrumbs (enriching-events/breadcrumbs) :
    • Specify available keys, return None behavior, and link hints; add Python includes for automatic breadcrumbs and breadcrumb hint (log_record).
  • Identify user: clarify IP extraction, {{auto}}, and defaults.
  • Scopes: minor wording to reflect SDK-managed scopes.
  • Performance metrics: minor wording to refer to “the SDK.”
  • Fingerprinting/Usage/Sessions: tighten language to Python context and examples.

Written by Cursor Bugbot for commit c031835. This will update automatically on new commits. Configure here.

Copy link

vercel bot commented Sep 30, 2025

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Preview Comments Updated (UTC)
develop-docs Canceled Canceled Sep 30, 2025 1:45pm
sentry-docs Canceled Canceled Sep 30, 2025 1:45pm

Copy link

codecov bot commented Sep 30, 2025

Bundle Report

Changes will increase total bundle size by 879 bytes (0.0%) ⬆️. This is within the configured threshold ✅

Detailed changes
Bundle name Size Change
sentry-docs-client-array-push 10.13MB -6 bytes (-0.0%) ⬇️
sentry-docs-server-cjs 12.9MB 885 bytes (0.01%) ⬆️

Affected Assets, Files, and Routes:

view changes for bundle: sentry-docs-server-cjs

Assets Changed:

Asset Name Size Change Total Size Change (%)
1729.js -3 bytes 1.78MB -0.0%
../instrumentation.js -3 bytes 1.1MB -0.0%
9523.js -3 bytes 1.08MB -0.0%
../app/[[...path]]/page.js.nft.json 298 bytes 838.82kB 0.04%
../app/platform-redirect/page.js.nft.json 298 bytes 838.73kB 0.04%
../app/sitemap.xml/route.js.nft.json 298 bytes 835.96kB 0.04%
view changes for bundle: sentry-docs-client-array-push

Assets Changed:

Asset Name Size Change Total Size Change (%)
static/chunks/pages/_app-*.js -3 bytes 882.71kB -0.0%
static/chunks/8321-*.js -3 bytes 425.87kB -0.0%
static/k37JKXXFGZEjtHegkiYvp/_buildManifest.js (New) 684 bytes 684 bytes 100.0% 🚀
static/k37JKXXFGZEjtHegkiYvp/_ssgManifest.js (New) 77 bytes 77 bytes 100.0% 🚀
static/hoMFaYIYetjUK8v1r-*.js (Deleted) -684 bytes 0 bytes -100.0% 🗑️
static/hoMFaYIYetjUK8v1r-*.js (Deleted) -77 bytes 0 bytes -100.0% 🗑️

@alexander-alderman-webb alexander-alderman-webb merged commit df8f0d4 into master Sep 30, 2025
13 checks passed
@alexander-alderman-webb alexander-alderman-webb deleted the webb/remove-generic-references-python branch September 30, 2025 14:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Remove generic references from Python SDK docs
2 participants