-
-
Notifications
You must be signed in to change notification settings - Fork 906
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(readme.md): api methods table with description #160
Conversation
Make ctrl + f over the methods a lot easier on README.
✔️ Deploy Preview for vigilant-wescoff-04e480 ready! 🔨 Explore the source changes: 2aca12c 🔍 Inspect the deploy log: https://app.netlify.com/sites/vigilant-wescoff-04e480/deploys/61e7a2c5e322000007c94cc7 😎 Browse the preview: https://deploy-preview-160--vigilant-wescoff-04e480.netlify.app |
cause rendering issue
My opinion is that these should be moved to #82 and then rendered in the https://fakerjs.dev docs. While having in the README is nice, as the API expands we'll see that it becomes cumbersome to maintain. I like the descriptions here, perhaps we can move them into the codebase into the Docblocks if there are any methods missing descriptions? |
@damienwebdev I exactly thought the same, but for the short run, this is really nice 👍 |
Co-authored-by: Eric Cheng <ericcheng9316@gmail.com>
I can help with the docblocks, but merge this to another PR will become larger file changes, maybe if I can suggest I can help for the docblocks in different PR or the PR you mentioned. |
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.
lgtm
Co-authored-by: Eric Cheng <ericcheng9316@gmail.com>
Make ctrl + f over the methods a lot easier on README.