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 jsdocs to the pre-built instances #3193

Merged
merged 4 commits into from
Oct 21, 2024
Merged

Conversation

ST-DDT
Copy link
Member

@ST-DDT ST-DDT commented Oct 18, 2024

Fixes #2023

Add jsdocs to the localized faker instances and locale data.

@ST-DDT ST-DDT added c: docs Improvements or additions to documentation p: 1-normal Nothing urgent labels Oct 18, 2024
@ST-DDT ST-DDT added this to the vAnytime milestone Oct 18, 2024
@ST-DDT ST-DDT requested review from a team October 18, 2024 17:25
@ST-DDT ST-DDT self-assigned this Oct 18, 2024
Copy link

netlify bot commented Oct 18, 2024

Deploy Preview for fakerjs ready!

Name Link
🔨 Latest commit 621789c
🔍 Latest deploy log https://app.netlify.com/sites/fakerjs/deploys/67164cee7560780008eff4fb
😎 Deploy Preview https://deploy-preview-3193.fakerjs.dev
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

codecov bot commented Oct 18, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.95%. Comparing base (18e59aa) to head (621789c).
Report is 1 commits behind head on next.

Additional details and impacted files
@@           Coverage Diff            @@
##             next    #3193    +/-   ##
========================================
  Coverage   99.95%   99.95%            
========================================
  Files        2798     2798            
  Lines      216718   216718            
  Branches      575      951   +376     
========================================
+ Hits       216620   216628     +8     
+ Misses         98       90     -8     
Files with missing lines Coverage Δ
src/locale/af_ZA.ts 100.00% <ø> (ø)
src/locale/ar.ts 100.00% <ø> (ø)
src/locale/az.ts 100.00% <ø> (ø)
src/locale/base.ts 100.00% <ø> (ø)
src/locale/cs_CZ.ts 100.00% <ø> (ø)
src/locale/da.ts 100.00% <ø> (ø)
src/locale/de.ts 100.00% <ø> (ø)
src/locale/de_AT.ts 100.00% <ø> (ø)
src/locale/de_CH.ts 100.00% <ø> (ø)
src/locale/dv.ts 100.00% <ø> (ø)
... and 128 more

... and 1 file with indirect coverage changes

@ST-DDT ST-DDT added c: refactor PR that affects the runtime behavior, but doesn't add new features or fixes bugs c: infra Changes to our infrastructure or project setup labels Oct 18, 2024
@ST-DDT ST-DDT requested review from a team October 20, 2024 15:47
@ST-DDT ST-DDT enabled auto-merge (squash) October 21, 2024 12:45
@ST-DDT ST-DDT merged commit f917f4f into next Oct 21, 2024
21 checks passed
@ST-DDT ST-DDT deleted the docs/pre-built/description branch October 21, 2024 12:48
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: infra Changes to our infrastructure or project setup c: refactor PR that affects the runtime behavior, but doesn't add new features or fixes bugs p: 1-normal Nothing urgent
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Clearer documentation for fakerBASE
3 participants