[
https://issues.apache.org/jira/browse/ARROW-12531?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Dominik Moritz updated ARROW-12531:
-----------------------------------
Description:
Right now, the docs are very much just an API doc but they don't explain how to
use most of the library. We should
* add function comments
* remove internal functions from the docs
* add more examples
* document Vector
(https://arrow.apache.org/docs/js/modules/_vector_.vector.html is just a
namespace)
was:
Right now, the docs are very much just an API doc but they don't explain how to
use certain functions. We should
* add function comments
* remove internal functions from the docs
* add more examples
* document Vector
(https://arrow.apache.org/docs/js/modules/_vector_.vector.html is just a
namespace)
> [JS] Make the docs more user friendly
> -------------------------------------
>
> Key: ARROW-12531
> URL: https://issues.apache.org/jira/browse/ARROW-12531
> Project: Apache Arrow
> Issue Type: Improvement
> Components: JavaScript
> Reporter: Dominik Moritz
> Priority: Major
>
> Right now, the docs are very much just an API doc but they don't explain how
> to use most of the library. We should
> * add function comments
> * remove internal functions from the docs
> * add more examples
> * document Vector
> (https://arrow.apache.org/docs/js/modules/_vector_.vector.html is just a
> namespace)
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
