Skip to content

docs(react): Add JSDoc to withSentryRouting - #24012

Merged
chargome merged 1 commit into
developfrom
sentry-routing-docs-revie
Sep 3, 2026
Merged

docs(react): Add JSDoc to withSentryRouting#24012
chargome merged 1 commit into
developfrom
sentry-routing-docs-revie

Conversation

@chargome

@chargome chargome commented Sep 3, 2026

Copy link
Copy Markdown
Member

Documents that withSentryRouting targets React Router v4/v5 only, needs the wrapped Route rendered inside a Switch, and that v6+ users should reach for wrapReactRouterRouting instead.

The HOC is the only routing wrapper in the package without a doc comment, so
nothing tells users it targets React Router v4/v5 only, that the wrapped Route
must be rendered inside a Switch, or that v6+ should use wrapReactRouterRouting.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01MQRr9S6B2FYBKa9bMWHSxk
@chargome chargome self-assigned this Sep 3, 2026
@github-actions

github-actions Bot commented Sep 3, 2026

Copy link
Copy Markdown
Contributor

size-limit report 📦

Path Size % Change Change
@sentry/browser 28.71 kB - -
@sentry/browser - with treeshaking flags 27.02 kB - -
@sentry/browser - with treeshaking flags tracing without tracing 26.92 kB - -
@sentry/browser (incl. Tracing) 49.1 kB - -
@sentry/browser (incl. Tracing + Span Streaming) 49.1 kB - -
@sentry/browser (incl. Tracing, Profiling) 52.01 kB - -
@sentry/browser (incl. Tracing, Replay) 88.58 kB - -
@sentry/browser (incl. Tracing, Replay) - with treeshaking flags 77.88 kB - -
@sentry/browser (incl. Tracing, Replay with Canvas) 93.26 kB - -
@sentry/browser (incl. Tracing, Replay, Feedback) 106.21 kB - -
@sentry/browser (incl. Feedback) 46.2 kB - -
@sentry/browser (incl. sendFeedback) 33.78 kB - -
@sentry/browser (incl. FeedbackAsync) 38.87 kB - -
@sentry/browser (incl. Metrics) 29.68 kB - -
@sentry/browser (incl. Logs) 29.97 kB - -
@sentry/browser (incl. Metrics & Logs) 30.61 kB - -
@sentry/react 30.47 kB - -
@sentry/react (incl. Tracing) 51.3 kB - -
@sentry/vue 35.95 kB - -
@sentry/vue (incl. Tracing) 51.37 kB - -
@sentry/svelte 28.74 kB - -
CDN Bundle 30.45 kB - -
CDN Bundle (incl. Tracing) 49.64 kB - -
CDN Bundle (incl. Logs, Metrics) 32.69 kB - -
CDN Bundle (incl. Tracing, Logs, Metrics) 51.56 kB - -
CDN Bundle (incl. Replay, Logs, Metrics) 73.28 kB - -
CDN Bundle (incl. Tracing, Replay) 87.13 kB - -
CDN Bundle (incl. Tracing, Replay, Logs, Metrics) 89 kB - -
CDN Bundle (incl. Tracing, Replay, Feedback) 93.06 kB - -
CDN Bundle (incl. Tracing, Replay, Feedback, Logs, Metrics) 95.01 kB - -
CDN Bundle - uncompressed 90.19 kB - -
CDN Bundle (incl. Tracing) - uncompressed 147.87 kB - -
CDN Bundle (incl. Logs, Metrics) - uncompressed 96.58 kB - -
CDN Bundle (incl. Tracing, Logs, Metrics) - uncompressed 153.65 kB - -
CDN Bundle (incl. Replay, Logs, Metrics) - uncompressed 225.75 kB - -
CDN Bundle (incl. Tracing, Replay) - uncompressed 267.37 kB - -
CDN Bundle (incl. Tracing, Replay, Logs, Metrics) - uncompressed 273.13 kB - -
CDN Bundle (incl. Tracing, Replay, Feedback) - uncompressed 281.07 kB - -
CDN Bundle (incl. Tracing, Replay, Feedback, Logs, Metrics) - uncompressed 286.82 kB - -
@sentry/nextjs (client) 53.92 kB - -
@sentry/sveltekit (client) 49.53 kB - -
@sentry/core/server 40.96 kB - -
@sentry/core/browser 13.53 kB - -
@sentry/node 124.66 kB +0.02% +21 B 🔺
@sentry/node/import (ESM hook with diagnostics-channel injection) 81.51 kB - -
@sentry/node - without tracing 88.5 kB +0.03% +23 B 🔺
@sentry/node - without channel injection 103.95 kB +0.03% +23 B 🔺
@sentry/aws-serverless 96.87 kB +0.03% +24 B 🔺
@sentry/cloudflare (withSentry) - minified 201.56 kB - -
@sentry/cloudflare (withSentry) 501.37 kB - -

View base workflow run

@chargome
chargome marked this pull request as ready for review September 3, 2026 12:50
@chargome
chargome requested a review from a team as a code owner September 3, 2026 12:50
@chargome
chargome requested review from mydea and s1gr1d and removed request for a team September 3, 2026 12:50
@chargome chargome assigned mydea and s1gr1d and unassigned mydea and s1gr1d Sep 3, 2026
@mydea

mydea commented Sep 3, 2026

Copy link
Copy Markdown
Member

Maybe we can think about, for v12 or whenever, to split these into a router-v4 or router-v5 entrypoint so we can better isolate what is relevant for which version. but not sure... def. an improvement to have jsdocs here now ❤️

@chargome
chargome merged commit ef113e2 into develop Sep 3, 2026
130 checks passed
@chargome
chargome deleted the sentry-routing-docs-revie branch September 3, 2026 13:08
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.

3 participants