docs(breadcrumbs): 🏷️ add jsdoc for breadcrumbs #11504
Merged
Conversation
This file contains hidden or 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
cadesalaberry
force-pushed
the
docs/add-jsdoc-for-breadcrumbs
branch
from
4f0c653 to
67e4e02
Compare
Lms24
approved these changes
Apr 9, 2024
There was a problem hiding this comment.
Hey @cadesalaberry thanks for opening the PR!
This is pretty sophisticated JSDoc which we usually don't do in this capacity but it's completely fine to merge IMO. Thanks!
cadesalaberry
added a commit
to cadesalaberry/sentry-javascript
that referenced
this pull request
Apr 19, 2024
When interacting with the Breadcrumd API, I had some trouble finding the correct documentation. I retrieved my changes for the previous [PR](getsentry#11119) to make sure the JSDoc is updated with the actual doc.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
When interacting with the Breadcrumd API, I had some trouble finding the correct documentation. I retrieved my changes for the previous PR to make sure the JSDoc is updated with the actual doc.
Before submitting a pull request, please take a look at our
Contributing guidelines and verify:
yarn lint) & (yarn test).