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

Improve API documentation #218

Closed
sebnitu opened this issue Jun 23, 2020 · 1 comment
Closed

Improve API documentation #218

sebnitu opened this issue Jun 23, 2020 · 1 comment

Comments

@sebnitu
Copy link
Owner

sebnitu commented Jun 23, 2020

Problem

The API documentation in README.md is currently all in tables. This leaves no room for real code examples, parameter descriptions or anything else.

Possible Solution

Could possibly take inspiration from jest-puppeteer and format it this way:

Example: https://github.com/smooth-code/jest-puppeteer#api

@sebnitu
Copy link
Owner Author

sebnitu commented Aug 20, 2020

This was finished in #320

Core table documentation has been removed since there have been many more modules added and they should all use the same API documentation formatting. A separate issue should be created for core documentation.

@sebnitu sebnitu closed this as completed Aug 20, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant