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

[Divyansh200102]

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

[github-actions]

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:

• Other pull requests
• Contribution Guidelines - How to contribute patches

[kou]

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]

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]

ditto.

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

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

[kou]

ditto.

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

(a representation of a RecordBatch IPC message)

[Divyansh200102]

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]

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]

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

[Divyansh200102]

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]

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]

Please review the changes @kou

[kou]

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

[Divyansh200102]

Done @kou

[kou]

@github-actions crossbow submit preview-docs

[github-actions]

Revision: b934b66

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

Task	Status
preview-docs

[kou]

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]

@AlenkaF Could you help us for reST markup?

[AlenkaF]

@github-actions crossbow submit preview-docs

[github-actions]

Revision: 8d294b7

Submitted crossbow builds: ursacomputing/crossbow @ actions-b2a30f86b0

Task	Status
preview-docs

[AlenkaF]

@github-actions crossbow submit preview-docs

[github-actions]

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]

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.