dubzzz / fast-check

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

📝 Add missing options in the documentation for `float` and `double` #5137

Closed dubzzz closed 3 months ago

dubzzz commented 3 months ago

Description

The documentation was missing some attributes. This PR makes sure we have them properly displayed in the documentation.

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

Advanced

codesandbox-ci[bot] commented 3 months 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 d01a1a862636df47404f0c0cbf44c15b12b3b69e:

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

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

codecov[bot] commented 3 months ago

Codecov Report

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

Project coverage is 94.79%. Comparing base (ed3dd61) to head (d01a1a8). Report is 2 commits behind head on main.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #5137 +/- ## ======================================= Coverage 94.79% 94.79% ======================================= Files 218 218 Lines 9248 9248 Branches 2702 2702 ======================================= Hits 8767 8767 Misses 481 481 ``` | [Flag](https://app.codecov.io/gh/dubzzz/fast-check/pull/5137/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/5137/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Nicolas+DUBIEN) | `94.79% <ø> (ø)` | | | [unit-tests-18.x-Linux](https://app.codecov.io/gh/dubzzz/fast-check/pull/5137/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Nicolas+DUBIEN) | `94.74% <ø> (-0.06%)` | :arrow_down: | | [unit-tests-20.x-Linux](https://app.codecov.io/gh/dubzzz/fast-check/pull/5137/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Nicolas+DUBIEN) | `94.79% <ø> (ø)` | | | [unit-tests-22.x-Linux](https://app.codecov.io/gh/dubzzz/fast-check/pull/5137/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Nicolas+DUBIEN) | `94.79% <ø> (+0.05%)` | :arrow_up: | | [unit-tests-latest-Linux](https://app.codecov.io/gh/dubzzz/fast-check/pull/5137/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Nicolas+DUBIEN) | `94.79% <ø> (ø)` | | 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.