Skip to content

Add types to code snippets for hooks #13437

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

Merged
merged 4 commits into from
Apr 22, 2025
Merged

Conversation

antonpirker
Copy link
Member

@antonpirker antonpirker commented Apr 17, 2025

DESCRIBE YOUR PR

Some users where complaining because they did not know how to properly type their hooks that they can define for configuring Sentry SDK. This update adds those types to the code snippets.

This PR needs this PR for all types to be available publicly to use: getsentry/sentry-python#4315

Preview (examples):

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

Copy link

vercel bot commented Apr 17, 2025

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

Name Status Preview Comments Updated (UTC)
sentry-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Apr 17, 2025 2:01pm
2 Skipped Deployments
Name Status Preview Comments Updated (UTC)
changelog ⬜️ Ignored (Inspect) Visit Preview Apr 17, 2025 2:01pm
develop-docs ⬜️ Ignored (Inspect) Visit Preview Apr 17, 2025 2:01pm

Copy link

codecov bot commented Apr 17, 2025

Bundle Report

Changes will decrease total bundle size by 15 bytes (-0.0%) ⬇️. This is within the configured threshold ✅

Detailed changes
Bundle name Size Change
sentry-docs-server-cjs 11.14MB -9 bytes (-0.0%) ⬇️
sentry-docs-client-array-push 9.47MB -6 bytes (-0.0%) ⬇️

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.75MB -0.0%
../instrumentation.js -3 bytes 1.08MB -0.0%
9523.js -3 bytes 1.05MB -0.0%
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 868.7kB -0.0%
static/chunks/8165-*.js -3 bytes 410.1kB -0.0%
static/B4g07UToACoSAJFOQo9Np/_buildManifest.js (New) 578 bytes 578 bytes 100.0% 🚀
static/B4g07UToACoSAJFOQo9Np/_ssgManifest.js (New) 77 bytes 77 bytes 100.0% 🚀
static/VdcxafA8wzHYAy6o6Pyva/_buildManifest.js (Deleted) -578 bytes 0 bytes -100.0% 🗑️
static/VdcxafA8wzHYAy6o6Pyva/_ssgManifest.js (Deleted) -77 bytes 0 bytes -100.0% 🗑️

Copy link
Contributor

@coolguyzone coolguyzone left a comment

Choose a reason for hiding this comment

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

LGTM

@antonpirker antonpirker merged commit f374a0b into master Apr 22, 2025
15 checks passed
@antonpirker antonpirker deleted the antonpirker/python-typing branch April 22, 2025 06:52
antonpirker added a commit to getsentry/sentry-python that referenced this pull request Apr 22, 2025
Make types that users can use when configuring the SDK public. 

Accompaniyng docs update:
getsentry/sentry-docs#13437

Fixes #4127
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.

2 participants