ARROW-5563: [Format] Update integration test JSON format documentation #6377
Conversation
kszucs
force-pushed
the
integration-test-docs
branch
from
3579d5b
to
de85df0
Compare
nealrichardson
force-pushed
the
integration-test-docs
branch
from
de85df0
to
9152a91
Compare
Co-Authored-By: Benjamin Kietzman <bengilgit@gmail.com>
| "count" "field_length", | ||
| "$BUFFER_TYPE": /* BufferData */ | ||
| ... | ||
| "$BUFFER_TYPE": /* BufferData */ |
There was a problem hiding this comment.
For the record, it might be preferable to instead have a "buffers": [BufferData]
There was a problem hiding this comment.
Maybe so though that's out of scope here since I'm documenting as-built.
| The integration test data generator and runner uses ``archery``, a Python script | ||
| that requires Python 3.6 or higher. You can create a standalone Python | ||
| distribution and environment for running the tests by using | ||
| `miniconda <https://conda.io/miniconda.html>`_. On Linux this is: |
There was a problem hiding this comment.
Do we really have to repeat the Miniconda install instructions on every other documentation page? That isn't scalable. I suggest to either let the user figure it out (it isn't difficult) or to put those in a dedicated page (development FAQ perhaps?).
| refer to it if you have questions about how to build other languages or enable | ||
| certain tests. | ||
|
|
||
| See :ref:`integration` for more information about the project's |
There was a problem hiding this comment.
It's a pity that other page is also called "integration"... that's confusing. Perhaps rename it?
There was a problem hiding this comment.
https://issues.apache.org/jira/browse/ARROW-7122 is the issue for improving the docker-compose documentation: we should fix this there.
| @@ -63,7 +53,10 @@ such topics as: | |||
|
|
|||
| cpp/index | |||
| python/index | |||
| java/index | |||
| `Java <https://arrow.apache.org/docs/java/>`_ | |||
There was a problem hiding this comment.
It looks like this syntax breaks the side bar (did you test?). See screenshot below:
https://framapic.org/gYWKmMs30com/kHYNqQJCHhf7.png
This fills in details about all types (AFAIK) and adds a couple of examples.