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: show examples for modules #2406

Merged
merged 11 commits into from
Sep 19, 2023
Merged

docs: show examples for modules #2406

merged 11 commits into from
Sep 19, 2023

Conversation

matthewmayer
Copy link
Contributor

@matthewmayer matthewmayer commented Sep 18, 2023 •
edited
Loading

Shows @example blocks for modules (ie Faker and SimpleFaker) in the
generated docs.

Screenshot 2023-09-18 at 19 22 35

@matthewmayer matthewmayer requested a review from a team as a code owner September 18, 2023 12:50
@Shinigami92
Copy link
Member

(Currently on mobile) the PR title should just be docs: ...

@matthewmayer matthewmayer changed the title feat(docs): show examples for modules docs: show examples for modules Sep 18, 2023
@codecov
Copy link

codecov bot commented Sep 18, 2023 •
edited
Loading

Codecov Report

Merging #2406 (bee6dd2) into next (d264100) will decrease coverage by 0.01%.
The diff coverage is n/a.

Additional details and impacted files 
@@            Coverage Diff             @@
##             next    #2406      +/-   ##
==========================================
- Coverage   99.60%   99.60%   -0.01%     
==========================================
  Files        2801     2801              
  Lines      252469   252469              
  Branches     1102     1101       -1     
==========================================
- Hits       251483   251481       -2     
- Misses        959      961       +2     
  Partials       27       27

see 2 files with indirect coverage changes

ST-DDT
ST-DDT reviewed Sep 18, 2023
View reviewed changes
@matthewmayer matthewmayer marked this pull request as draft September 18, 2023 16:56
ST-DDT
ST-DDT reviewed Sep 18, 2023
View reviewed changes
@ST-DDT ST-DDT added this to the vAnytime milestone Sep 18, 2023
@ST-DDT ST-DDT added c: docs Improvements or additions to documentation p: 1-normal Nothing urgent labels Sep 18, 2023
@matthewmayer matthewmayer marked this pull request as ready for review September 19, 2023 15:41
@Shinigami92 Shinigami92 requested review from ST-DDT and a team September 19, 2023 15:52
@Shinigami92 Shinigami92 requested a review from a team September 19, 2023 15:53
ST-DDT
ST-DDT approved these changes Sep 19, 2023
View reviewed changes
@Shinigami92 Shinigami92 enabled auto-merge (squash) September 19, 2023 19:47
@Shinigami92 Shinigami92 merged commit 8e4172b into faker-js:next Sep 19, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ST-DDT ST-DDT ST-DDT approved these changes

@Shinigami92 Shinigami92 Shinigami92 approved these changes

@xDivisionByZerox xDivisionByZerox xDivisionByZerox approved these changes

Assignees

@matthewmayer matthewmayer

Labels
c: docs Improvements or additions to documentation p: 1-normal Nothing urgent
Projects
None yet
Milestone
v8.1 - Split Faker Class
Development

Successfully merging this pull request may close these issues.
4 participants
@matthewmayer @Shinigami92 @ST-DDT @xDivisionByZerox