Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

GH-35369: [Docs] Fix reST markup around ref:IPC format <format-ipc> #38276

Merged
merged 8 commits into from
Jan 22, 2024
Merged

GH-35369: [Docs] Fix reST markup around ref:IPC format <format-ipc> #38276

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
7f8553c
fix reStructuredText link markup
Divyansh200102 Oct 15, 2023
f2f3047
Update tables.rst
Divyansh200102 Oct 24, 2023
426254e
Update overview.rst
Divyansh200102 Oct 24, 2023
ef33421
Update vector_schema_root.rst
Divyansh200102 Oct 24, 2023
8459a9c
Update Glossary.rst
Divyansh200102 Oct 24, 2023
b934b66
Update vector_schema_root.rst
Divyansh200102 Jan 20, 2024
8d294b7
Update docs/source/format/Glossary.rst
Divyansh200102 Jan 22, 2024
37e8fdc
Update docs/source/format/Glossary.rst
AlenkaF Jan 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/source/format/Glossary.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -174,7 +174,7 @@ Glossary
.. seealso:: :term:`data type`

record batch
**In the :ref:`IPC format <format-ipc>`**: the primitive unit
**In the :ref:`IPC format <format-ipc>` **: the primitive unit
Divyansh200102 marked this conversation as resolved.
Show resolved Hide resolved
of data. A record batch consists of an ordered list of
:term:`buffers <buffer>` corresponding to a :term:`schema`.

Expand Down
2 changes: 1 addition & 1 deletion docs/source/java/vector_schema_root.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ Here is an example of creating a VectorSchemaRoot:

Data can be loaded into/unloaded from a VectorSchemaRoot via `VectorLoader`_
and `VectorUnloader`_. They handle converting between VectorSchemaRoot and
`ArrowRecordBatch`_ (a representation of a RecordBatch :ref:`IPC <format-ipc>`
`ArrowRecordBatch`_ (a representation of a RecordBatch :ref:`IPC <format-ipc>`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It seems that we don't need this:

https://arrow.apache.org/docs/java/vector_schema_root.html#vectorschemaroot

ArrowRecordBatch (a representation of a RecordBatch IPC message).

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done @kou

message). For example:

.. code-block:: Java
Expand Down