-
-
Notifications
You must be signed in to change notification settings - Fork 929
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
docs: add missing throw descriptions in JSDocs #2560
Conversation
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## next #2560 +/- ##
==========================================
- Coverage 99.57% 99.57% -0.01%
==========================================
Files 2805 2805
Lines 250168 250179 +11
Branches 1107 1106 -1
==========================================
+ Hits 249117 249120 +3
- Misses 1023 1031 +8
Partials 28 28
|
This is somewhat blocked by #2444 |
Should we add https://github.com/faker-js/faker/labels/s:%20on%20hold? |
The jsdocs get improved by this regardless, so I don't consider it worth hard blocking. |
This is no longer soft blocked by #2444. |
Co-authored-by: Eric Cheng <ericcheng9316@gmail.com>
Add missing and updated
@throw
descriptions in the JSDocs for the following functions:Additionally, to make sure that those statements are actually true, I adjusted or extended the test for those functions as well.