Skip to content

Commit c2d2727

Browse files
authored
GH-46942: [Docs] Replace the directive versionadded with note (#46997)
### Rationale for this change The Sphinx directive `versionadded` expects a `version` argument and an optional description of the change ([docs](https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-versionadded)). The Columnar Format docs pass "Arrow Columnar Format" (unquoted) to the directive, causing only "Arrow" to be rendered as version. Fixes #46942 ### What changes are included in this PR? Replaces `versionadded` with `note`, following the suggestion in #46942 (comment). ### Are these changes tested? [Yes:](http://crossbow.voltrondata.com/pr_docs/46997/format/Columnar.html#arrow-columnar-format) <img width="765" height="124" alt="Screenshot 2025-07-28 at 13 10 58" src="https://github.com/user-attachments/assets/dd2222b3-c463-4b73-ab1d-fbd99e46a390" /> (The initial commits also tested if the label could be quoted or its whitespaces escaped to prevent it from getting broken up.) ### Are there any user-facing changes? Docs only. * GitHub Issue: #46942 Authored-by: Fabian Iwand <[email protected]> Signed-off-by: Sutou Kouhei <[email protected]>
1 parent c9adb63 commit c2d2727

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

docs/source/format/Columnar.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -482,7 +482,7 @@ will be represented as follows: ::
482482
Variable-size Binary View Layout
483483
--------------------------------
484484

485-
.. versionadded:: Arrow Columnar Format 1.4
485+
.. note:: New in version Arrow Columnar Format 1.4
486486

487487
Each value in this layout consists of 0 or more bytes. These bytes'
488488
locations are indicated using a **views** buffer, which may point to one
@@ -628,7 +628,7 @@ will be represented as follows: ::
628628
ListView Layout
629629
~~~~~~~~~~~~~~~
630630

631-
.. versionadded:: Arrow Columnar Format 1.4
631+
.. note:: New in version Arrow Columnar Format 1.4
632632

633633
The ListView layout is defined by three buffers: a validity bitmap, an offsets
634634
buffer, and an additional sizes buffer. Sizes and offsets have the identical bit
@@ -1085,7 +1085,7 @@ below.
10851085
Run-End Encoded Layout
10861086
----------------------
10871087

1088-
.. versionadded:: Arrow Columnar Format 1.3
1088+
.. note:: New in version Arrow Columnar Format 1.3
10891089

10901090
Run-end encoding (REE) is a variation of run-length encoding (RLE). These
10911091
encodings are well-suited for representing data containing sequences of the
@@ -1360,7 +1360,7 @@ memory size rather than the padded size.
13601360
Variadic buffers
13611361
----------------
13621362

1363-
.. versionadded:: Arrow Columnar Format 1.4
1363+
.. note:: New in version Arrow Columnar Format 1.4
13641364

13651365
Some types such as Utf8View are represented using a variable number of buffers.
13661366
For each such Field in the pre-ordered flattened logical schema, there will be

0 commit comments

Comments
 (0)