[GitHub] distinctdan opened a new issue #286: The docs lack a description of all available methods and their expected params and types

[GitBox <gi...@apache.org>]

distinctdan opened a new issue #286: The docs lack a description of all available methods and their expected params and types
URL: https://github.com/apache/cordova-plugin-file/issues/286
 
 
   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

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services

---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@cordova.apache.org
For additional commands, e-mail: commits-help@cordova.apache.org