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.

Sign up for GitHub

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

Jump to bottom

docs: generate docs for fake() and unique() #564

Merged
merged 9 commits into from
Mar 1, 2022
Merged

docs: generate docs for fake() and unique() #564

merged 9 commits into from
Mar 1, 2022

Conversation

ST-DDT
Copy link
Member

@ST-DDT ST-DDT commented Feb 25, 2022

No description provided.

@ST-DDT ST-DDT added the c: docs Improvements or additions to documentation label Feb 25, 2022
@ST-DDT ST-DDT self-assigned this Feb 25, 2022
@ST-DDT ST-DDT requested a review from a team as a code owner February 25, 2022 19:28
@ST-DDT
Copy link
Member Author

ST-DDT commented Feb 25, 2022

Side question: Should I start splitting that script into multiple files? Where should I place them? scripts/apiDocs/*?

@codecov
Copy link

codecov bot commented Feb 25, 2022 •
edited
Loading

Codecov Report

Merging #564 (282a824) into main (442812f) will increase coverage by 0.00%.
The diff coverage is 100.00%.

@@           Coverage Diff           @@
##             main     #564   +/-   ##
=======================================
  Coverage   99.34%   99.34%           
=======================================
  Files        1920     1920           
  Lines      176371   176374    +3     
  Branches      906      906           
=======================================
+ Hits       175216   175219    +3     
  Misses       1099     1099           
  Partials       56       56
Impacted Files Coverage Δ
src/fake.ts 100.00% <100.00%> (ø)
src/unique.ts 100.00% <100.00%> (ø)

@Shinigami92
Copy link
Member

Side question: Should I start splitting that script into multiple files? Where should I place them? scripts/apiDocs/*?

Yes, we don't have a strict current way of structure for scripts folder. Feel free to define one 🙂
If helpful, do it directly in this PR

Shinigami92
Shinigami92 reviewed Feb 25, 2022
View reviewed changes
@ST-DDT ST-DDT requested review from Shinigami92 and a team February 25, 2022 22:36
@Shinigami92 Shinigami92 requested a review from a team February 26, 2022 09:59
This was referenced Feb 26, 2022
Merged
Merged
Merged
Closed
@Shinigami92 Shinigami92 merged commit 61fafe4 into main Mar 1, 2022
@Shinigami92 Shinigami92 deleted the docs/generate-docs-for-injected-methods branch March 1, 2022 18:55
demipel8 pushed a commit to demipel8/faker that referenced this pull request Mar 11, 2022
@ST-DDT @demipel8
docs: generate docs for fake() and unique() (faker-js#564)
15715c1
@ST-DDT ST-DDT removed this from the v6 - Non-Breaking Changes milestone Apr 19, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@prisis prisis prisis approved these changes

@Shinigami92 Shinigami92 Shinigami92 approved these changes

Assignees

@ST-DDT ST-DDT

Labels
c: docs Improvements or additions to documentation
Projects
None yet
Milestone
v6.0 - Ensure Project Foundation
Development

Successfully merging this pull request may close these issues.
3 participants
@ST-DDT @Shinigami92 @prisis