Add JSDoc @description support #194
Merged
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
grrowl
force-pushed
the
add-jsdoc-description-support
branch
from
0efbbde
to
81fc78e
Compare
|
can you please update the documentation in README.md as well? |
schiller-manuel
requested changes
Jan 7, 2024
|
@schiller-manuel thanks for the quick review, have added to README and added functionality/coverage |
Codecov ReportAttention:
❗ Your organization needs to install the Codecov GitHub app to enable full functionality. Additional details and impacted files@@ Coverage Diff @@
## main #194 +/- ##
==========================================
- Coverage 97.40% 96.89% -0.52%
==========================================
Files 14 14
Lines 733 741 +8
Branches 304 309 +5
==========================================
+ Hits 714 718 +4
- Misses 19 23 +4 ☔ View full report in Codecov by Sentry. |
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.
Why
Fixes #193 — now JSDoc
@descriptiontags are applied to the Zod schema via.describe()Helps for when Zod schemas are flowing further downstream into JSONSchemas and such :)