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: add missing throw descriptions in JSDocs #2560

Merged
merged 4 commits into from
Dec 4, 2023

Conversation

xDivisionByZerox
Copy link
Member

Add missing and updated @throw descriptions in the JSDocs for the following functions:

Updated Added
faker.number.int faker.number.int
faker.number.float faker.number.float
faker.number.binary faker.number.binary
faker.number.octal faker.number.octal
faker.number.hex faker.number.hex
faker.number.bigInt
faker.datatype.number faker.datatype.number
faker.datatype.float

Additionally, to make sure that those statements are actually true, I adjusted or extended the test for those functions as well.

@xDivisionByZerox xDivisionByZerox added c: docs Improvements or additions to documentation p: 1-normal Nothing urgent m: datatype Something is referring to the datatype module m: number Something is referring to the number module labels Nov 25, 2023
@xDivisionByZerox xDivisionByZerox added this to the vAnytime milestone Nov 25, 2023
@xDivisionByZerox xDivisionByZerox requested a review from a team November 25, 2023 13:45
@xDivisionByZerox xDivisionByZerox self-assigned this Nov 25, 2023
@xDivisionByZerox xDivisionByZerox requested a review from a team as a code owner November 25, 2023 13:45
Copy link

codecov bot commented Nov 25, 2023

Codecov Report

Merging #2560 (e7ff590) into next (505f659) will decrease coverage by 0.01%.
The diff coverage is 100.00%.

Additional details and impacted files
@@            Coverage Diff             @@
##             next    #2560      +/-   ##
==========================================
- Coverage   99.57%   99.57%   -0.01%     
==========================================
  Files        2805     2805              
  Lines      250168   250179      +11     
  Branches     1107     1106       -1     
==========================================
+ Hits       249117   249120       +3     
- Misses       1023     1031       +8     
  Partials       28       28              
Files Coverage Δ
src/modules/datatype/index.ts 100.00% <100.00%> (ø)
src/modules/number/index.ts 100.00% <100.00%> (ø)

... and 2 files with indirect coverage changes

@ST-DDT
Copy link
Member

ST-DDT commented Nov 25, 2023

This is somewhat blocked by #2444

ST-DDT
ST-DDT previously approved these changes Nov 25, 2023
@xDivisionByZerox
Copy link
Member Author

This is somewhat blocked by #2444

Should we add https://github.com/faker-js/faker/labels/s:%20on%20hold?

@ST-DDT
Copy link
Member

ST-DDT commented Nov 25, 2023

The jsdocs get improved by this regardless, so I don't consider it worth hard blocking.
(It only looks slightly ugly in the api-docs)

src/modules/number/index.ts Outdated Show resolved Hide resolved
src/modules/number/index.ts Outdated Show resolved Hide resolved
src/modules/number/index.ts Outdated Show resolved Hide resolved
src/modules/number/index.ts Outdated Show resolved Hide resolved
src/modules/number/index.ts Outdated Show resolved Hide resolved
@ST-DDT
Copy link
Member

ST-DDT commented Dec 3, 2023

This is no longer soft blocked by #2444.

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 m: datatype Something is referring to the datatype module m: number Something is referring to the number module p: 1-normal Nothing urgent
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants