GH-35369: [Docs] Fix reST markup around ref:`IPC format <format-ipc>` by Divyansh200102 · Pull Request #38276 · apache/arrow

Divyansh200102 · 2023-10-15T19:38:10Z

Closes: [Docs] reStructuredText link markup is broken #35369

github-actions · 2023-10-15T19:38:39Z

Thanks for opening a pull request!

If this is not a minor PR. Could you open an issue for this pull request on GitHub? https://github.com/apache/arrow/issues/new/choose

Opening GitHub issues ahead of time contributes to the Openness of the Apache Arrow project.

Then could you also rename the pull request title in the following format?

GH-${GITHUB_ISSUE_ID}: [${COMPONENT}] ${SUMMARY}

or

MINOR: [${COMPONENT}] ${SUMMARY}

In the case of PARQUET issues on JIRA the title also supports:

PARQUET-${JIRA_ISSUE_ID}: [${COMPONENT}] ${SUMMARY}

See also:

kou · 2023-10-16T00:56:32Z

Could you read the auto-generated comment?
#38276 (comment)

And could you read our pull request template and follow it instead of remove it entirely without reading it?

kou

Could you check your change on local?
See also: https://arrow.apache.org/docs/developers/documentation.html#building-with-docker

I think that the following is the needed change:

diff --git a/docs/source/format/Glossary.rst b/docs/source/format/Glossary.rst
index 65d6e0afa..d0adc0cc3 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 <format-ipc>`**: the primitive unit
+       **In the :ref:`IPC format <format-ipc>` **: the primitive unit
        of data.  A record batch consists of an ordered list of
        :term:`buffers <buffer>` corresponding to a :term:`schema`.

kou · 2023-10-18T00:53:43Z

docs/source/cpp/tables.rst


 Record batches can be sent between implementations, such as via 
-:ref:`IPC <format-ipc>` or
+:ref:`IPC format <format-ipc>` or


Is this really needed?
https://arrow.apache.org/docs/cpp/tables.html#record-batches renders correctly without this:

Record batches can be sent between implementations, such as via IPC or via ...

kou · 2023-10-18T00:54:49Z

docs/source/developers/overview.rst

   and writing various file formats, such as Parquet.
 2. Cross endian support (implementations will do byte reordering when
-   appropriate for :ref:`IPC <format-ipc>` and :ref:`Flight <flight-rpc>`
+   appropriate for :ref:`IPC format <format-ipc>` and :ref:`Flight <flight-rpc>`


ditto.

https://arrow.apache.org/docs/developers/overview.html#endianness

(implementations will do byte reordering when appropriate for IPC and...

kou · 2023-10-18T00:55:41Z

docs/source/java/vector_schema_root.rst

 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 <format-ipc>` 


ditto.

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

(a representation of a RecordBatch IPC message)

Divyansh200102 · 2023-10-18T07:38:58Z

hi, @kou i am trying to setup the project locally using the docker-compose.yml file by using the command "docker compose up -d" but this is error is showing up (Error response from daemon: manifest for amd64/maven:3.5.4-eclipse-temurin-8 not found: manifest unknown: manifest unknown) i think this version of amd64/maven is not in the registry .i tried pulling manually as well but still nothing can you help me out to solve this?i checked docker hub as well but this version of amd64/maven is not there.

raulcd · 2023-10-18T10:50:54Z

Hi @Divyansh200102 we use docker-compose as a utility to help us run different testing containers mainly for CI and some locally but we don't use docker-compose up as we have lots of images and this is not supposed to work.
Due to the large amount of languages and tools in the Apache Arrow repository we have in this contribution guide several examples on how to build and test locally for the different languages. Please take a look there and don't hesitate on asking if something is not clear enough: https://arrow.apache.org/docs/dev/developers/guide/index.html

raulcd · 2023-10-18T10:53:02Z

BTW if you are trying to build the documentation locally here is the documentation: https://arrow.apache.org/docs/developers/documentation.html

Divyansh200102 · 2023-10-19T07:40:47Z

i am encountering this @raulcd
https://gist.github.com/Divyansh200102/7e26fc47fd2f66a438970c5d8f1fae4f
i ran {pip install -e "dev/archery[all]"} this command to install the archery and after that ran the docker command {archery docker run -v "${PWD}/docs:/build/docs" ubuntu-docs} but it's throwing error
archery is built but i am not able to run the docker command even though the archery is built still it's saying that archery command is not recognised .

raulcd · 2023-10-19T09:27:55Z

Hi @Divyansh200102 , it seems to be failing on building pygit2 which is a dependency for Archery:

Failed to build pygit2
ERROR: Could not build wheels for pygit2, which is required to install pyproject.toml-based projects

I am not entirely sure what the problem is with the logs provided but you are probably using Python 3.12 and that's why there are no wheels available yet for them as seen on PyPI: https://pypi.org/project/pygit2/#files
If you want to build from source you'll need to follow their installation guide requirements for Windows: https://www.pygit2.org/install.html#installing-on-windows

Divyansh200102 · 2024-01-20T18:21:40Z

Please review the changes @kou

kou · 2024-01-20T21:18:24Z

docs/source/java/vector_schema_root.rst

 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>` 


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

kou · 2024-01-20T21:58:45Z

@github-actions crossbow submit preview-docs

github-actions · 2024-01-20T22:01:00Z

Revision: b934b66

Submitted crossbow builds: ursacomputing/crossbow @ actions-3dedf8ca9e

Task	Status
preview-docs

kou · 2024-01-21T02:48:00Z

Hmm. The "IPC format" link markup is solved but the ** ... ** mark is broken...

http://crossbow.voltrondata.com/pr_docs/38276/format/Glossary.html#term-record-batch

**In the IPC format **: the primitive unit of data.

kou · 2024-01-21T02:49:35Z

@AlenkaF Could you help us for reST markup?

docs/source/format/Glossary.rst

Co-authored-by: Alenka Frim <AlenkaF@users.noreply.github.com>

AlenkaF · 2024-01-22T14:05:58Z

@github-actions crossbow submit preview-docs

github-actions · 2024-01-22T14:08:32Z

Revision: 8d294b7

Submitted crossbow builds: ursacomputing/crossbow @ actions-b2a30f86b0

Task	Status
preview-docs

docs/source/format/Glossary.rst

AlenkaF · 2024-01-22T15:24:36Z

@github-actions crossbow submit preview-docs

github-actions · 2024-01-22T15:28:01Z

Revision: 37e8fdc

Submitted crossbow builds: ursacomputing/crossbow @ actions-04924a384c

Task	Status
preview-docs

AlenkaF

Looks good now 👍
http://crossbow.voltrondata.com/pr_docs/38276/format/Glossary.html#term-record-batch

conbench-apache-arrow · 2024-01-23T00:15:54Z

After merging your PR, Conbench analyzed the 4 benchmarking runs that have been run so far on merge-commit 315e06a.

There were no benchmark performance regressions. 🎉

The full Conbench report has more details.

…mat-ipc>` (apache#38276) * Closes: apache#35369 Lead-authored-by: Divyansh200102 <divyanshkhatri200102@gmail.com> Co-authored-by: Divyansh200102 <146909065+Divyansh200102@users.noreply.github.com> Co-authored-by: Alenka Frim <AlenkaF@users.noreply.github.com> Signed-off-by: AlenkaF <frim.alenka@gmail.com>

fix reStructuredText link markup

7f8553c

github-actions bot added Component: Documentation awaiting review Awaiting review labels Oct 15, 2023

Divyansh200102 changed the title ~~fix reStructuredText link markup~~ GH-35369:[Docs] updated :ref:IPC format <format-ipc>' instead of ref:IPC <format-ipc>` Oct 16, 2023

Divyansh200102 changed the title ~~GH-35369:[Docs] updated :ref:IPC format <format-ipc>' instead of ref:IPC <format-ipc>`~~ GH-35369:[Docs] updated ref:IPC <format-ipc> to ref:`IPC format <format-ipc>' Oct 16, 2023

kou reviewed Oct 18, 2023

View reviewed changes

kou changed the title ~~GH-35369:[Docs] updated ref:IPC <format-ipc> to ref:`IPC format <format-ipc>'~~ GH-35369: [Docs] updated ref:IPC <format-ipc> to ref:`IPC format <format-ipc>' Oct 18, 2023

github-actions bot added awaiting changes Awaiting changes and removed awaiting review Awaiting review labels Oct 18, 2023

Divyansh200102 closed this Oct 19, 2023

Divyansh200102 reopened this Oct 19, 2023

Divyansh200102 added 2 commits October 24, 2023 10:48

Update tables.rst

f2f3047

Update overview.rst

426254e

github-actions bot added awaiting change review Awaiting change review and removed awaiting changes Awaiting changes labels Oct 24, 2023

Divyansh200102 added 2 commits October 24, 2023 10:49

Update vector_schema_root.rst

ef33421

Update Glossary.rst

8459a9c

kou changed the title ~~GH-35369: [Docs] updated ref:IPC <format-ipc> to ref:`IPC format <format-ipc>'~~ GH-35369: [Docs] updated ref:IPC <format-ipc> to ref:IPC format <format-ipc> Jan 20, 2024

kou reviewed Jan 20, 2024

View reviewed changes

kou changed the title ~~GH-35369: [Docs] updated ref:IPC <format-ipc> to ref:IPC format <format-ipc>~~ GH-35369: [Docs] Update ref:IPC <format-ipc> to ref:IPC format <format-ipc> Jan 20, 2024

github-actions bot added awaiting changes Awaiting changes and removed awaiting change review Awaiting change review labels Jan 20, 2024

kou changed the title ~~GH-35369: [Docs] Update ref:IPC <format-ipc> to ref:IPC format <format-ipc>~~ GH-35369: [Docs] Add a missing space after ref:IPC format <format-ipc> Jan 20, 2024

Update vector_schema_root.rst

b934b66

github-actions bot added awaiting change review Awaiting change review and removed awaiting changes Awaiting changes labels Jan 20, 2024

AlenkaF reviewed Jan 22, 2024

View reviewed changes

docs/source/format/Glossary.rst Outdated Show resolved Hide resolved

Update docs/source/format/Glossary.rst

8d294b7

Co-authored-by: Alenka Frim <AlenkaF@users.noreply.github.com>

AlenkaF reviewed Jan 22, 2024

View reviewed changes

docs/source/format/Glossary.rst Outdated Show resolved Hide resolved

Update docs/source/format/Glossary.rst

37e8fdc

AlenkaF approved these changes Jan 22, 2024

View reviewed changes

AlenkaF merged commit 315e06a into apache:main Jan 22, 2024

AlenkaF removed the awaiting change review Awaiting change review label Jan 22, 2024

kou changed the title ~~GH-35369: [Docs] Add a missing space after ref:IPC format <format-ipc>~~ GH-35369: [Docs] Fix reST markup around ref:IPC format <format-ipc> Jan 22, 2024

Divyansh200102 deleted the fix-reStructuredText-link-markup branch January 23, 2024 03:34

Conversation

Divyansh200102 commented Oct 15, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Oct 15, 2023

Uh oh!

kou commented Oct 16, 2023

Uh oh!

kou left a comment

Choose a reason for hiding this comment

Uh oh!

kou Oct 18, 2023

Choose a reason for hiding this comment

Uh oh!

kou Oct 18, 2023

Choose a reason for hiding this comment

Uh oh!

kou Oct 18, 2023

Choose a reason for hiding this comment

Uh oh!

Divyansh200102 commented Oct 18, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

raulcd commented Oct 18, 2023

Uh oh!

raulcd commented Oct 18, 2023

Uh oh!

Divyansh200102 commented Oct 19, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

raulcd commented Oct 19, 2023

Uh oh!

Divyansh200102 commented Jan 20, 2024

Uh oh!

kou Jan 20, 2024

Choose a reason for hiding this comment

Uh oh!

Divyansh200102 Jan 20, 2024

Choose a reason for hiding this comment

Uh oh!

kou commented Jan 20, 2024

Uh oh!

github-actions bot commented Jan 20, 2024

Uh oh!

kou commented Jan 21, 2024

Uh oh!

kou commented Jan 21, 2024

Uh oh!

Uh oh!

AlenkaF commented Jan 22, 2024

Uh oh!

github-actions bot commented Jan 22, 2024

Uh oh!

Uh oh!

AlenkaF commented Jan 22, 2024

Uh oh!

github-actions bot commented Jan 22, 2024

Uh oh!

AlenkaF left a comment

Choose a reason for hiding this comment

Uh oh!

conbench-apache-arrow bot commented Jan 23, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Divyansh200102 commented Oct 15, 2023 •

edited

Loading

Divyansh200102 commented Oct 18, 2023 •

edited

Loading

Divyansh200102 commented Oct 19, 2023 •

edited

Loading