jasondavies / science.js

Scientific and statistical computing in JavaScript.
http://www.jasondavies.com/
Other
886 stars 93 forks source link

Documentation needed for functions #15

Open sathishvj opened 9 years ago

sathishvj commented 9 years ago

I came in via a non R background and needed to use some variance, quantiles, and standard deviation functions for a project. Because of the lack of documentation, I looked for other libraries also and the only thing that made me stay was mike bostocks' recommendation.

I think if the documentation is improved with a) available functions b) a couple of samples, it could really help people like me quickly adopt this library.

p.s. I shall also try to edit the md file and issue a pull request with the docs.

ndarville commented 9 years ago

I think Jason has a lot on his plate:

I’m sure he’ll be more than happy to accept pull requests from anyone capable and willing, though. We can always annotate the code itself with Docco or contribute to a wiki.

I find GitHub wikis to have a less-than-stellar navigation UI, so better expand the repo itself with documentation. :)