-
-
Notifications
You must be signed in to change notification settings - Fork 974
test(docs): ensure defaults are consistent #2177
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
Conversation
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## next #2177 +/- ##
==========================================
- Coverage 99.57% 99.57% -0.01%
==========================================
Files 2801 2801
Lines 249842 249908 +66
Branches 1082 1080 -2
==========================================
+ Hits 248792 248843 +51
- Misses 1022 1037 +15
Partials 28 28
|
Should we use |
Team decision We will omit/remove the empty options default for now in the jsdocs. |
Created after seeing #2175.
Unfortunately there is currently no way to automatically detect issues where the jsdocs on the signature level differ from those on the options object because typedoc erases the signature ones if the option's one is present. But I found a way to at least check that the options one is present. And that the not-option ones match the js impl default one.
(it also can only check the last api signature)