docs: add more examples in jsdoc#291
Merged
nozomuikuta merged 6 commits intounjs:mainfrom Apr 15, 2025
Merged
Conversation
nozomuikuta
reviewed
Apr 11, 2025
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #291 +/- ##
==========================================
+ Coverage 95.27% 97.65% +2.38%
==========================================
Files 7 7
Lines 867 724 -143
Branches 187 242 +55
==========================================
- Hits 826 707 -119
+ Misses 41 17 -24 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
nozomuikuta
approved these changes
Apr 15, 2025
Member
nozomuikuta
left a comment
There was a problem hiding this comment.
I just pushed a commit to delete a redundant line break.
Thank you for the PR!
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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 this PR, I’ve added JSDoc comments to most of the utility functions, in the hope that these examples can help users better understand the purpose and usage of each function.
Perhaps we could also consider including some of them in the README?