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: expose documentation for all utilities #3242

Merged
merged 11 commits into from
Nov 14, 2024
Merged

docs: expose documentation for all utilities #3242

merged 11 commits into from
Nov 14, 2024

Conversation

ST-DDT
Copy link
Member

@ST-DDT ST-DDT commented Nov 2, 2024

Extension of #3221


Treats all functions inside the utils folder as public utilities that need documentation.

Also adds a test to ensure that the elements don't change unexpectedly.

@ST-DDT ST-DDT added c: docs Improvements or additions to documentation p: 1-normal Nothing urgent labels Nov 2, 2024
@ST-DDT ST-DDT added this to the vAnytime milestone Nov 2, 2024
@ST-DDT ST-DDT self-assigned this Nov 2, 2024
Copy link

codecov bot commented Nov 2, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.95%. Comparing base (467bd83) to head (61d6bf4).
Report is 1 commits behind head on next.

Additional details and impacted files
@@            Coverage Diff             @@
##             next    #3242      +/-   ##
==========================================
- Coverage   99.97%   99.95%   -0.02%     
==========================================
  Files        2806     2806              
  Lines      217144   217144              
  Branches      979      974       -5     
==========================================
- Hits       217081   217052      -29     
- Misses         63       92      +29     

see 2 files with indirect coverage changes

@ST-DDT ST-DDT changed the title docs: expose documentation for randomizers docs: expose documentation for all utilities Nov 2, 2024
Base automatically changed from docs/utils/randomizer to next November 3, 2024 09:08
Copy link

netlify bot commented Nov 3, 2024

Deploy Preview for fakerjs ready!

Name Link
🔨 Latest commit 61d6bf4
🔍 Latest deploy log https://app.netlify.com/sites/fakerjs/deploys/67366d57ea99fe0008efddcf
😎 Deploy Preview https://deploy-preview-3242.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.

@ST-DDT ST-DDT marked this pull request as ready for review November 3, 2024 16:29
@ST-DDT ST-DDT requested a review from a team as a code owner November 3, 2024 16:29
@ST-DDT ST-DDT requested a review from a team November 3, 2024 16:29
Copy link
Member

@xDivisionByZerox xDivisionByZerox left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm fine with the change in general. I'm unsure whether including all function in the snapshot is necessary. 🤔
This concern is not blocking, tho.

@ST-DDT
Copy link
Member Author

ST-DDT commented Nov 11, 2024

I'm unsure whether including all function in the snapshot is necessary. 🤔

I don't think it is necessary either, but currently we don't have any tests that cover the completeness of the docs generation.
This is my attempt to cover this. (I did start with just the utilities module at first, but picking that from the page list is harder than just checking the whole set.)

@ST-DDT ST-DDT added this pull request to the merge queue Nov 14, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Nov 14, 2024
@ST-DDT ST-DDT enabled auto-merge (squash) November 14, 2024 21:39
@ST-DDT ST-DDT merged commit ef24bff into next Nov 14, 2024
23 checks passed
@ST-DDT ST-DDT deleted the docs/utils/all branch November 14, 2024 21:41
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.

2 participants