-
-
Notifications
You must be signed in to change notification settings - Fork 939
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: deprecate randomize #506
docs: deprecate randomize #506
Conversation
Codecov Report
@@ Coverage Diff @@
## main #506 +/- ##
=======================================
Coverage 99.33% 99.33%
=======================================
Files 1920 1920
Lines 176466 176487 +21
Branches 905 905
=======================================
+ Hits 175286 175307 +21
Misses 1124 1124
Partials 56 56
|
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.
Please move the @deprecated
tag down to comply with #512
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.
Could you please add a check in the test that the warning is called?
We already do this for methods in random here:
Line 239 in 2d68da1
`Deprecation Warning: faker.random.${functionName} is now located in faker.${newLocation}` |
Created in relation to #466.
What has changed:
The jsdoc of
helpers.randomize
now includes the@deprecated
decorator.Furthermore, the method will now print a
console.warn
to inform the end-user about the deprecation.