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

feat(js): Add docs for updateSpanName #11824

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Conversation

Lms24
Copy link
Member

@Lms24 Lms24 commented Nov 14, 2024

DESCRIBE YOUR PR

To be merged only once getsentry/sentry-javascript#14291 was released

This PR:

  • adds documentation for Sentry.updateSpanName, a helper function we (unfortunately) had to add to the JS SDK
  • rewords the previous span.updateName documentation, leaving the shortcomings of the previous way to update a span name in Node in place
  • does not touch the React Native docs because I think it's fine for RN users (given it's based on @sentry/react) to continue using span.updateName. Happy to change this if reviewers have different opinions

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 Nov 14, 2024

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 Dec 11, 2024 10:46am
2 Skipped Deployments
Name Status Preview Comments Updated (UTC)
changelog ⬜️ Ignored (Inspect) Visit Preview Dec 11, 2024 10:46am
develop-docs ⬜️ Ignored (Inspect) Visit Preview Dec 11, 2024 10:46am

@Lms24 Lms24 force-pushed the lms/feat-updateSpanName branch from f7cbbe7 to 99ec67e Compare November 14, 2024 16:39
@Lms24 Lms24 self-assigned this Nov 14, 2024
@Lms24 Lms24 requested review from mydea and andreiborza November 14, 2024 16:43
Copy link

codecov bot commented Nov 14, 2024

Bundle Report

Changes will increase total bundle size by 255.64kB (1.28%) ⬆️. This is within the configured threshold ✅

Detailed changes
Bundle name Size Change
sentry-docs-server-cjs 10.6MB 255.65kB (2.47%) ⬆️
sentry-docs-client-array-push 9.27MB 6 bytes (-0.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.

Added a couple suggestions, LGTM!

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.

Thanks for adding!

@getsantry
Copy link
Contributor

getsantry bot commented Dec 10, 2024

This pull request has gone three weeks without activity. In another week, I will close it.

But! If you comment or otherwise update it, I will reset the clock, and if you add the label WIP, I will leave it alone unless WIP is removed ... forever!


"A weed is but an unloved flower." ― Ella Wheeler Wilcox 🥀

@getsantry getsantry bot removed the Stale label Dec 11, 2024
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