dubzzz / fast-check

Property based testing framework for JavaScript (like QuickCheck) written in TypeScript
https://fast-check.dev/
MIT License
4.29k stars 178 forks source link

📝 Better `string`'s deprecation note in documentation #5240

Closed dubzzz closed 3 weeks ago

dubzzz commented 3 weeks ago

Description

Our documentation was forcing users to open the associated deprecation Pull Request in order to read for the recommended alternates to the deprecated helpers.

This PR makes sure we just link to string when it is the recommended replacement.

ChecklistDon't delete this checklist and make sure you do the following before opening the PR

Advanced

changeset-bot[bot] commented 3 weeks ago

⚠️ No Changeset found

Latest commit: c6096f5277ad602af26854ee7181d40305f7315f

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

codesandbox-ci[bot] commented 3 weeks ago

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit c6096f5277ad602af26854ee7181d40305f7315f:

Sandbox Source
@fast-check/examples Configuration
github-actions[bot] commented 3 weeks ago

👋 A preview of the new documentation is available at: http://66caea57551a897f6dfeddbc--dubzzz-fast-check.netlify.app

codecov[bot] commented 3 weeks ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 95.32%. Comparing base (19f1bb1) to head (c6096f5). Report is 2 commits behind head on main.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #5240 +/- ## ======================================= Coverage 95.32% 95.32% ======================================= Files 234 234 Lines 10414 10414 Branches 2774 2774 ======================================= Hits 9927 9927 Misses 487 487 ``` | [Flag](https://app.codecov.io/gh/dubzzz/fast-check/pull/5240/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Nicolas+DUBIEN) | Coverage Δ | | |---|---|---| | [unit-tests](https://app.codecov.io/gh/dubzzz/fast-check/pull/5240/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Nicolas+DUBIEN) | `95.32% <ø> (ø)` | | | [unit-tests-18.x-Linux](https://app.codecov.io/gh/dubzzz/fast-check/pull/5240/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Nicolas+DUBIEN) | `95.32% <ø> (ø)` | | | [unit-tests-20.x-Linux](https://app.codecov.io/gh/dubzzz/fast-check/pull/5240/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Nicolas+DUBIEN) | `95.32% <ø> (ø)` | | | [unit-tests-22.x-Linux](https://app.codecov.io/gh/dubzzz/fast-check/pull/5240/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Nicolas+DUBIEN) | `95.32% <ø> (ø)` | | | [unit-tests-latest-Linux](https://app.codecov.io/gh/dubzzz/fast-check/pull/5240/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Nicolas+DUBIEN) | `95.32% <ø> (ø)` | | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Nicolas+DUBIEN#carryforward-flags-in-the-pull-request-comment) to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.