[jira] [Commented] (ARROW-12531) [JS] Make the docs more user friendly

["Brian Hulette (Jira)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/ARROW-12531?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17332521#comment-17332521 ] 

Brian Hulette commented on ARROW-12531:
---------------------------------------

+1 for non-API docs. The arquero docs are beautiful and could definitely be a good model.

> [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 cover
>  * add function/class comments
>  ** What does Table.isValid do? Can tables be invalid somehow???
>  ** Document {{Table.get}} and {{Table.getChildAt}}.
>  ** What is the difference between {{getColumnAt}} and {{getChildAt}} (for Tables and Columns)?
> ** scan vs forEach?
>  ** Why is {{BindFunc}} optional in {{Table.scan}}?
>  * remove internal functions from the docs
>  * Document Vectors ([https://arrow.apache.org/docs/js/modules/_vector_.vector.html] is just a namespace)
>  * Make sure {{IntVector}} and {{FloatVector}} appear in docs
>  * What is the difference between {{Table}} and {{DataFrame}}?
>  * Add more examples
> As a good inspiration, we can look at [https://uwdata.github.io/arquero/api/].



--
This message was sent by Atlassian Jira
(v8.3.4#803005)