Uploaded image for project: 'Apache Arrow'
  1. Apache Arrow
  2. ARROW-12531

[JS] Make the docs more user friendly

    XMLWordPrintableJSON

Details

    • Improvement
    • Status: Closed
    • Major
    • Resolution: Fixed
    • None
    • None
    • JavaScript
    • None

    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 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/.

      Attachments

        Issue Links

          Activity

            People

              Unassigned Unassigned
              domoritz Dominik Moritz
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved:

                Time Tracking

                  Estimated:
                  Original Estimate - Not Specified
                  Not Specified
                  Remaining:
                  Remaining Estimate - 0h
                  0h
                  Logged:
                  Time Spent - 20m
                  20m