[
https://issues.apache.org/jira/browse/ARROW-12531?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17518157#comment-17518157
]
Dominik Moritz commented on ARROW-12531:
----------------------------------------
I think we can close this since we made some changes and more ideas are in
ARROW-16039.
> [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.20.1#820001)
