docs: add missing throw descriptions in JSDocs #2560
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
xDivisionByZerox
added
c: docs
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 |
ST-DDT
previously approved these changes
Nov 25, 2023
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>
matthewmayer
approved these changes
Dec 3, 2023
ST-DDT
approved these changes
Dec 3, 2023
import-brain
approved these changes
Dec 4, 2023
This was referenced Sep 13, 2024
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.
Add missing and updated
@throwdescriptions 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.