From 7f8553c48f2a69f05f7a2daab6a7d5fbd92c8190 Mon Sep 17 00:00:00 2001 From: Divyansh200102 Date: Mon, 16 Oct 2023 01:05:38 +0530 Subject: [PATCH 1/8] fix reStructuredText link markup --- docs/source/cpp/tables.rst | 2 +- docs/source/developers/overview.rst | 2 +- docs/source/java/vector_schema_root.rst | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/source/cpp/tables.rst b/docs/source/cpp/tables.rst index b28a9fc1e13a5..c5d8ac65b2521 100644 --- a/docs/source/cpp/tables.rst +++ b/docs/source/cpp/tables.rst @@ -82,7 +82,7 @@ and computation functions, possibly incremental. structure as described in text above. Record batches can be sent between implementations, such as via -:ref:`IPC ` or +:ref:`IPC format ` or via the :doc:`C Data Interface <../format/CDataInterface>`. Tables and chunked arrays, on the other hand, are concepts in the C++ implementation, not in the Arrow format itself, so they aren't directly portable. diff --git a/docs/source/developers/overview.rst b/docs/source/developers/overview.rst index c7bc4273313bc..8ad29c9485eba 100644 --- a/docs/source/developers/overview.rst +++ b/docs/source/developers/overview.rst @@ -184,7 +184,7 @@ implementation can support: same endianness). This includes ancillary functionality such as reading and writing various file formats, such as Parquet. 2. Cross endian support (implementations will do byte reordering when - appropriate for :ref:`IPC ` and :ref:`Flight ` + appropriate for :ref:`IPC format ` and :ref:`Flight ` messages). The decision on what level to support is based on maintainers' preferences for diff --git a/docs/source/java/vector_schema_root.rst b/docs/source/java/vector_schema_root.rst index 3615fe9c72631..32c58be23cb19 100644 --- a/docs/source/java/vector_schema_root.rst +++ b/docs/source/java/vector_schema_root.rst @@ -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 ` +`ArrowRecordBatch`_ (a representation of a RecordBatch :ref:`IPC format ` message). For example: .. code-block:: Java From f2f30472e4af164ac28ae021eb6963000691f8db Mon Sep 17 00:00:00 2001 From: Divyansh200102 <146909065+Divyansh200102@users.noreply.github.com> Date: Tue, 24 Oct 2023 10:48:27 +0530 Subject: [PATCH 2/8] Update tables.rst --- docs/source/cpp/tables.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/cpp/tables.rst b/docs/source/cpp/tables.rst index c5d8ac65b2521..b28a9fc1e13a5 100644 --- a/docs/source/cpp/tables.rst +++ b/docs/source/cpp/tables.rst @@ -82,7 +82,7 @@ and computation functions, possibly incremental. structure as described in text above. Record batches can be sent between implementations, such as via -:ref:`IPC format ` or +:ref:`IPC ` or via the :doc:`C Data Interface <../format/CDataInterface>`. Tables and chunked arrays, on the other hand, are concepts in the C++ implementation, not in the Arrow format itself, so they aren't directly portable. From 426254e79cb3aeaf0dac5b9c651f7e13c0d64aad Mon Sep 17 00:00:00 2001 From: Divyansh200102 <146909065+Divyansh200102@users.noreply.github.com> Date: Tue, 24 Oct 2023 10:49:05 +0530 Subject: [PATCH 3/8] Update overview.rst --- docs/source/developers/overview.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/developers/overview.rst b/docs/source/developers/overview.rst index 8ad29c9485eba..c7bc4273313bc 100644 --- a/docs/source/developers/overview.rst +++ b/docs/source/developers/overview.rst @@ -184,7 +184,7 @@ implementation can support: same endianness). This includes ancillary functionality such as reading and writing various file formats, such as Parquet. 2. Cross endian support (implementations will do byte reordering when - appropriate for :ref:`IPC format ` and :ref:`Flight ` + appropriate for :ref:`IPC ` and :ref:`Flight ` messages). The decision on what level to support is based on maintainers' preferences for From ef3342194c1fe5598d6689c91d905cd0c93b57c7 Mon Sep 17 00:00:00 2001 From: Divyansh200102 <146909065+Divyansh200102@users.noreply.github.com> Date: Tue, 24 Oct 2023 10:49:42 +0530 Subject: [PATCH 4/8] Update vector_schema_root.rst --- docs/source/java/vector_schema_root.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/java/vector_schema_root.rst b/docs/source/java/vector_schema_root.rst index 32c58be23cb19..763c741b7ffe8 100644 --- a/docs/source/java/vector_schema_root.rst +++ b/docs/source/java/vector_schema_root.rst @@ -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 ` +`ArrowRecordBatch`_ (a representation of a RecordBatch :ref:`IPC ` message). For example: .. code-block:: Java From 8459a9c688566b2f0c8767776585843ec677895e Mon Sep 17 00:00:00 2001 From: Divyansh200102 <146909065+Divyansh200102@users.noreply.github.com> Date: Tue, 24 Oct 2023 10:52:48 +0530 Subject: [PATCH 5/8] Update Glossary.rst --- docs/source/format/Glossary.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/format/Glossary.rst b/docs/source/format/Glossary.rst index 65d6e0afa4557..d0adc0cc31f0a 100644 --- a/docs/source/format/Glossary.rst +++ b/docs/source/format/Glossary.rst @@ -174,7 +174,7 @@ Glossary .. seealso:: :term:`data type` record batch - **In the :ref:`IPC format `**: the primitive unit + **In the :ref:`IPC format ` **: the primitive unit of data. A record batch consists of an ordered list of :term:`buffers ` corresponding to a :term:`schema`. From b934b666cf6c9abb937938229ae429d68465db7c Mon Sep 17 00:00:00 2001 From: Divyansh200102 <146909065+Divyansh200102@users.noreply.github.com> Date: Sun, 21 Jan 2024 03:19:23 +0530 Subject: [PATCH 6/8] Update vector_schema_root.rst --- docs/source/java/vector_schema_root.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/java/vector_schema_root.rst b/docs/source/java/vector_schema_root.rst index 763c741b7ffe8..3615fe9c72631 100644 --- a/docs/source/java/vector_schema_root.rst +++ b/docs/source/java/vector_schema_root.rst @@ -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 ` +`ArrowRecordBatch`_ (a representation of a RecordBatch :ref:`IPC ` message). For example: .. code-block:: Java From 8d294b7058f72cbbc6b0c0b6b46e7edf208d6d08 Mon Sep 17 00:00:00 2001 From: Divyansh200102 <146909065+Divyansh200102@users.noreply.github.com> Date: Mon, 22 Jan 2024 18:15:47 +0530 Subject: [PATCH 7/8] Update docs/source/format/Glossary.rst Co-authored-by: Alenka Frim --- docs/source/format/Glossary.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/format/Glossary.rst b/docs/source/format/Glossary.rst index d0adc0cc31f0a..1a33aabb0873e 100644 --- a/docs/source/format/Glossary.rst +++ b/docs/source/format/Glossary.rst @@ -174,7 +174,7 @@ Glossary .. seealso:: :term:`data type` record batch - **In the :ref:`IPC format ` **: the primitive unit + **In the** :ref:`IPC format `: the primitive unit of data. A record batch consists of an ordered list of :term:`buffers ` corresponding to a :term:`schema`. From 37e8fdc11dba543f5680e49c088b9d7b36f6c18c Mon Sep 17 00:00:00 2001 From: Alenka Frim Date: Mon, 22 Jan 2024 16:24:16 +0100 Subject: [PATCH 8/8] Update docs/source/format/Glossary.rst --- docs/source/format/Glossary.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/format/Glossary.rst b/docs/source/format/Glossary.rst index 1a33aabb0873e..3f2f118a95d6d 100644 --- a/docs/source/format/Glossary.rst +++ b/docs/source/format/Glossary.rst @@ -174,7 +174,7 @@ Glossary .. seealso:: :term:`data type` record batch - **In the** :ref:`IPC format `: the primitive unit + **In the** :ref:`IPC format `: the primitive unit of data. A record batch consists of an ordered list of :term:`buffers ` corresponding to a :term:`schema`.