fix(native): provide an example for the breadcrumb data property #9141
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@supervacuus is attempting to deploy a commit to the Sentry Team on Vercel. A member of the Team first needs to authorize it. |
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
vivianyentran
approved these changes
Feb 14, 2024
|
Hi @vivianyentran and @kahest. How can I help to get this example merged? |
|
I went ahead and merged this for you! If you had any more edits to make, feel free to add another PR. Thanks! |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In the same vein as this: getsentry/sentry-native#951
There is currently no example in the docs that clarifies the necessity of a wrapping object for the
dataproperty in breadcrumbs. Users tried to assign JSON as a string for instance.The example is straight out of the develop docs: https://develop.sentry.dev/sdk/event-payloads/breadcrumbs/#breadcrumb-types. Not sure if we should mention this, because the surroundings docs already do.
cc: @kahest