-
-
Notifications
You must be signed in to change notification settings - Fork 40
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
Add the disableDescription
flag, which can be used to NOT print a description for a schema, even if it has been defined previously.
#403
Conversation
…scription for a schema, even if it has been defined previously. This can also be useful when dealing with objects with patterns and the `unknownType` meta. In such cases, the description of the `unknownType` is propagated to the map entry, creating sometimes a bit of confusion because the description belongs to each map entry's value and not its key.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #403 +/- ##
==========================================
+ Coverage 98.69% 98.72% +0.02%
==========================================
Files 9 9
Lines 537 547 +10
Branches 207 209 +2
==========================================
+ Hits 530 540 +10
Misses 7 7 ☔ View full report in Codecov by Sentry. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
the test it doesn't seem to be working?
@mrjono1 The test is working in the sense that it discards the description, but if the |
yeah I think it should make no jsdoc be produced for this field |
@mrjono1 what if instead of |
ignoreDescription
flag, which can be used to NOT print a description for a schema, even if it has been defined previously.disableDescription
flag, which can be used to NOT print a description for a schema, even if it has been defined previously.
This can also be useful when dealing with objects with patterns and the
unknownType
meta. In such cases, the description of theunknownType
is propagated to the map entry, creating sometimes a bit of confusion because the description belongs to each map entry's value and not its key.