-
-
Notifications
You must be signed in to change notification settings - Fork 954
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
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
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 |
✅ Deploy Preview for fakerjs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
There was a problem hiding this 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.
I don't think it is necessary either, but currently we don't have any tests that cover the completeness of the docs generation. |
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.