Skip to content
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

Merged
merged 6 commits into from
Mar 21, 2022
Merged

docs: deprecate randomize #506

merged 6 commits into from
Mar 21, 2022

Conversation

xDivisionByZerox
Copy link
Member

@xDivisionByZerox xDivisionByZerox commented Feb 18, 2022

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.

@xDivisionByZerox xDivisionByZerox requested a review from a team as a code owner February 18, 2022 17:47
@ejcheng ejcheng added the c: docs Improvements or additions to documentation label Feb 18, 2022
@ST-DDT ST-DDT linked an issue Feb 18, 2022 that may be closed by this pull request
@ST-DDT ST-DDT modified the milestone: v6.1 - First bugfixes Feb 18, 2022
@codecov
Copy link

codecov bot commented Feb 18, 2022

Codecov Report

Merging #506 (ae54af9) into main (6050d7a) will increase coverage by 0.00%.
The diff coverage is 100.00%.

❗ Current head ae54af9 differs from pull request most recent head 4a2b48e. Consider uploading reports for the commit 4a2b48e to get more accurate results

@@           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           
Impacted Files Coverage Δ
src/helpers.ts 99.11% <100.00%> (+<0.01%) ⬆️
src/iban.ts 100.00% <0.00%> (ø)

@Shinigami92 Shinigami92 added this to the v6.1 - First bugfixes milestone Feb 19, 2022
Copy link
Member

@ST-DDT ST-DDT left a 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

@Shinigami92 Shinigami92 added the do NOT merge yet Do not merge this PR into the target branch yet label Feb 19, 2022
ST-DDT
ST-DDT previously approved these changes Feb 19, 2022
@ST-DDT ST-DDT requested a review from a team February 19, 2022 12:41
Copy link
Member

@Shinigami92 Shinigami92 left a 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:

`Deprecation Warning: faker.random.${functionName} is now located in faker.${newLocation}`

@Shinigami92 Shinigami92 added c: refactor PR that affects the runtime behavior, but doesn't add new features or fixes bugs p: 1-normal Nothing urgent do NOT merge yet Do not merge this PR into the target branch yet and removed do NOT merge yet Do not merge this PR into the target branch yet labels Mar 15, 2022
Shinigami92
Shinigami92 previously approved these changes Mar 19, 2022
ST-DDT
ST-DDT previously approved these changes Mar 19, 2022
@Shinigami92 Shinigami92 dismissed stale reviews from ST-DDT and themself via 79af6e6 March 21, 2022 12:37
@Shinigami92 Shinigami92 enabled auto-merge (squash) March 21, 2022 12:44
@ST-DDT ST-DDT added the s: accepted Accepted feature / Confirmed bug label Mar 21, 2022
@Shinigami92 Shinigami92 merged commit 5a15c40 into faker-js:main Mar 21, 2022
@xDivisionByZerox xDivisionByZerox deleted the doc/depricate-randomize branch April 15, 2022 10:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
c: docs Improvements or additions to documentation c: refactor PR that affects the runtime behavior, but doesn't add new features or fixes bugs p: 1-normal Nothing urgent s: accepted Accepted feature / Confirmed bug
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Deprecate helpers.randomize
4 participants