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: fix missing or invalid jsdocs #2630

Merged
merged 4 commits into from
Feb 1, 2024
Merged

docs: fix missing or invalid jsdocs #2630

merged 4 commits into from
Feb 1, 2024

Conversation

ST-DDT
Copy link
Member

@ST-DDT ST-DDT commented Jan 28, 2024

During #2628 I found some issues with the existing jsdocs. This PR fixes them.
We should probably include them in a v8.x bugfix release to have a clean end to v8.

@ST-DDT ST-DDT added c: docs Improvements or additions to documentation p: 1-normal Nothing urgent labels Jan 28, 2024
@ST-DDT ST-DDT added this to the v8.x milestone Jan 28, 2024
@ST-DDT ST-DDT self-assigned this Jan 28, 2024
@ST-DDT ST-DDT requested a review from a team as a code owner January 28, 2024 18:35
@ST-DDT ST-DDT requested a review from a team January 28, 2024 18:36
src/faker.ts Outdated Show resolved Hide resolved
Copy link

codecov bot commented Jan 28, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (8ccc49d) 99.57% compared to head (16cdedc) 99.57%.

Additional details and impacted files
@@            Coverage Diff             @@
##             next    #2630      +/-   ##
==========================================
- Coverage   99.57%   99.57%   -0.01%     
==========================================
  Files        2807     2807              
  Lines      250452   250481      +29     
  Branches     1150     1148       -2     
==========================================
+ Hits       249388   249408      +20     
- Misses       1036     1045       +9     
  Partials       28       28              
Files Coverage Δ
src/faker.ts 89.42% <100.00%> (+0.28%) ⬆️
src/modules/location/index.ts 99.20% <100.00%> (-0.01%) ⬇️
src/simple-faker.ts 100.00% <100.00%> (ø)

... and 1 file with indirect coverage changes

@ST-DDT ST-DDT requested review from Shinigami92 and a team January 29, 2024 09:25
@ST-DDT ST-DDT merged commit 431681e into next Feb 1, 2024
20 checks passed
@ST-DDT ST-DDT deleted the jsdoc/signature-fixes branch February 1, 2024 16:27
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 p: 1-normal Nothing urgent
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants