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: Faker and utility pages #1940

Merged
merged 28 commits into from
Apr 3, 2023
Merged

docs: Faker and utility pages #1940

merged 28 commits into from
Apr 3, 2023

Conversation

ST-DDT
Copy link
Member

@ST-DDT ST-DDT commented Mar 16, 2023

This PR adds documentation pages for the Faker class and standalone utility methods.

Netlify-Preview: https://deploy-preview-2--serene-sprite-f3ef50.netlify.app/

@ST-DDT ST-DDT added c: docs Improvements or additions to documentation p: 1-normal Nothing urgent labels Mar 16, 2023
@ST-DDT ST-DDT added this to the v8.0 - Module Re-Shuffling milestone Mar 16, 2023
@ST-DDT ST-DDT self-assigned this Mar 16, 2023
@codecov
Copy link

codecov bot commented Mar 16, 2023

Codecov Report

Merging #1940 (8f863b0) into next (34b743a) will increase coverage by 0.01%.
The diff coverage is n/a.

Additional details and impacted files
@@            Coverage Diff             @@
##             next    #1940      +/-   ##
==========================================
+ Coverage   99.61%   99.62%   +0.01%     
==========================================
  Files        2561     2561              
  Lines      243239   243239              
  Branches     1274     1281       +7     
==========================================
+ Hits       242301   242330      +29     
+ Misses        913      884      -29     
  Partials       25       25              

see 2 files with indirect coverage changes

@matthewmayer
Copy link
Contributor

Should allLocales and allFakers be documented on these pages too? #1909

@ST-DDT
Copy link
Member Author

ST-DDT commented Mar 20, 2023

Should allLocales and allFakers be documented on these pages too? #1909

No, IMO they should be part of the localization page.

@ST-DDT ST-DDT marked this pull request as ready for review March 20, 2023 20:06
@ST-DDT ST-DDT requested a review from a team March 20, 2023 20:06
@ST-DDT ST-DDT requested a review from a team as a code owner March 20, 2023 20:06
@ST-DDT
Copy link
Member Author

ST-DDT commented Mar 22, 2023

I extracted the Faker jsdocs to its own PR #1960 to make reviewing them easier and let this PR focus on the infra/script side of things.

@ST-DDT ST-DDT added s: on hold Blocked by something or frozen to avoid conflicts c: infra Changes to our infrastructure or project setup needs rebase There is a merge conflict and removed s: on hold Blocked by something or frozen to avoid conflicts labels Mar 22, 2023
@ST-DDT ST-DDT removed the needs rebase There is a merge conflict label Mar 27, 2023
@ST-DDT ST-DDT requested review from matthewmayer and a team March 27, 2023 17:53
@ST-DDT ST-DDT added the s: accepted Accepted feature / Confirmed bug label Mar 27, 2023
@ST-DDT ST-DDT force-pushed the docs/faker-and-utility-page branch from 120150c to 18b5cad Compare April 1, 2023 19:19
@ST-DDT
Copy link
Member Author

ST-DDT commented Apr 1, 2023

I activated a deploy preview for this PR:

@matthewmayer
Copy link
Contributor

image

Tapping here goes to faker.html.html which 404s

@ST-DDT
Copy link
Member Author

ST-DDT commented Apr 2, 2023

@matthewmayer fixed

@ST-DDT ST-DDT requested a review from a team April 2, 2023 11:02
@ST-DDT ST-DDT requested a review from a team April 2, 2023 13:22
@ST-DDT ST-DDT merged commit edc50b6 into next Apr 3, 2023
@ST-DDT ST-DDT deleted the docs/faker-and-utility-page branch April 12, 2023 22:16
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 p: 1-normal Nothing urgent s: accepted Accepted feature / Confirmed bug
Projects
No open projects
Status: Done
Development

Successfully merging this pull request may close these issues.

3 participants