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

The docs lack a description of all available methods and their expected params and types #286

Open
distinctdan opened this issue Jan 6, 2019 · 1 comment

Comments

@distinctdan
Copy link

I'm trying to figure out if I can pass an ArrayBuffer to the file writer, but the docs don't have any kind of API documentation, only some scattered examples. I shouldn't have to go and read through the source to find out what each function really accepts. It would be a lot better if the docs included some standard, concise API documentation containing the following:

  • Method name
  • Parameters, whether they're optional, and their accepted types
  • Return value
@janpio
Copy link
Member

janpio commented Jan 9, 2019

We're happy to review and merge any PRs improving the documentation of this plugin of course!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants