docs(helpers): extend module jsdocs #1515
Merged
Conversation
This file contains hidden or 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
ST-DDT
added
c: docs
ST-DDT
changed the title
ST-DDT
changed the title
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## next #1515 +/- ##
=======================================
Coverage 99.63% 99.63%
=======================================
Files 2214 2214
Lines 238813 238812 -1
Branches 1029 1029
=======================================
- Hits 237951 237950 -1
Misses 841 841
Partials 21 21
|
ejcheng
reviewed
Nov 4, 2022
Co-authored-by: Eric Cheng <[email protected]>
Shinigami92
approved these changes
Nov 8, 2022
ejcheng
approved these changes
Nov 8, 2022
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.
Extend the helpers module jsdocs with a hint that these methods are intended to be used to build other faker methods.
Not sure about the exact wording.
As decided here: #1486 (comment)