You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@arrow.apache.org by "mootari (via GitHub)" <gi...@apache.org> on 2025/07/05 09:18:45 UTC
[PR] Quote the version argument in versionadded directives [arrow]
mootari opened a new pull request, #46997:
URL: https://github.com/apache/arrow/pull/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?
Quotes the version label to prevent it from getting parsed as multiple arguments.
### Are these changes tested?
Not yet. Depending on what the built preview will look like we may need to switch to a different directive like `note::` instead.
### Are there any user-facing changes?
Docs only.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] GH-46942: [Docs] Replace the directive versionadded with note [arrow]
Posted by "pitrou (via GitHub)" <gi...@apache.org>.
pitrou commented on PR #46997:
URL: https://github.com/apache/arrow/pull/46997#issuecomment-3200761810
The wording "New in version Arrow Columnar Format 1.4" isn't terrific, how about "New in Arrow Columnar Format 1.4" (no need for "version" and especially not _before_ the component name)?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] GH-46942: [Docs] Quote the version argument in versionadded directives [arrow]
Posted by "mootari (via GitHub)" <gi...@apache.org>.
mootari commented on PR #46997:
URL: https://github.com/apache/arrow/pull/46997#issuecomment-3106303307
@AlenkaF Yes, that's why I had left the PR in draft. I'm not sure why @pitrou marked it as ready for review without checking back first.
In any case, the previous attempts where meant to rule out simpler solutions. I'll try to find some time this week to switch to an info directive.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] GH-46942: [Docs] Replace the directive versionadded with note [arrow]
Posted by "kou (via GitHub)" <gi...@apache.org>.
kou commented on PR #46997:
URL: https://github.com/apache/arrow/pull/46997#issuecomment-3162048631
http://crossbow.voltrondata.com/pr_docs/46997/format/Columnar.html#variable-size-binary-view-layout
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] GH-46942: [Docs] Quote the version argument in versionadded directives [arrow]
Posted by "mootari (via GitHub)" <gi...@apache.org>.
mootari commented on PR #46997:
URL: https://github.com/apache/arrow/pull/46997#issuecomment-3041242657
@github-actions crossbow submit preview-docs
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Quote the version argument in versionadded directives [arrow]
Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #46997:
URL: https://github.com/apache/arrow/pull/46997#issuecomment-3038589077
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
Thanks for opening a pull request!
If this is not a [minor PR](https://github.com/apache/arrow/blob/main/CONTRIBUTING.md#Minor-Fixes). 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](http://theapacheway.com/open/#:~:text=Openness%20allows%20new%20users%20the,must%20happen%20in%20the%20open.) 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}
See also:
* [Other pull requests](https://github.com/apache/arrow/pulls/)
* [Contribution Guidelines - Contributing Overview](https://arrow.apache.org/docs/developers/overview.html)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] GH-46942: [Docs] Quote the version argument in versionadded directives [arrow]
Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #46997:
URL: https://github.com/apache/arrow/pull/46997#issuecomment-3038598250
:warning: GitHub issue #46942 **has been automatically assigned in GitHub** to PR creator.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] GH-46942: [Docs] Quote the version argument in versionadded directives [arrow]
Posted by "AlenkaF (via GitHub)" <gi...@apache.org>.
AlenkaF commented on PR #46997:
URL: https://github.com/apache/arrow/pull/46997#issuecomment-3105897127
@mootari thank you for trying to fix this!
Unfortunately it is not yet working correctly. This is the current view:
<img width="748" height="78" alt="Posnetek zaslona 2025–07–23 ob 08 09 37" src="https://github.com/user-attachments/assets/2710b246-e99f-413d-880f-de759787590f" />
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] GH-46942: [Docs] Replace the directive versionadded with note [arrow]
Posted by "kou (via GitHub)" <gi...@apache.org>.
kou commented on PR #46997:
URL: https://github.com/apache/arrow/pull/46997#issuecomment-3124869145
@github-actions crossbow submit preview-docs
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] GH-46942: [Docs] Quote the version argument in versionadded directives [arrow]
Posted by "mootari (via GitHub)" <gi...@apache.org>.
mootari commented on code in PR #46997:
URL: https://github.com/apache/arrow/pull/46997#discussion_r2188128107
##########
docs/source/format/Columnar.rst:
##########
@@ -1360,7 +1360,7 @@ memory size rather than the padded size.
Variadic buffers
----------------
-.. versionadded:: Arrow Columnar Format 1.4
+.. versionadded:: "Arrow Columnar Format 1.4"
Review Comment:
```suggestion
.. versionadded:: Arrow\ Columnar\ Format\ 1.4
```
##########
docs/source/format/Columnar.rst:
##########
@@ -482,7 +482,7 @@ will be represented as follows: ::
Variable-size Binary View Layout
--------------------------------
-.. versionadded:: Arrow Columnar Format 1.4
+.. versionadded:: "Arrow Columnar Format 1.4"
Review Comment:
```suggestion
.. versionadded:: Arrow\ Columnar\ Format\ 1.4
```
##########
docs/source/format/Columnar.rst:
##########
@@ -628,7 +628,7 @@ will be represented as follows: ::
ListView Layout
~~~~~~~~~~~~~~~
-.. versionadded:: Arrow Columnar Format 1.4
+.. versionadded:: "Arrow Columnar Format 1.4"
Review Comment:
```suggestion
.. versionadded:: Arrow\ Columnar\ Format\ 1.4
```
##########
docs/source/format/Columnar.rst:
##########
@@ -1085,7 +1085,7 @@ below.
Run-End Encoded Layout
----------------------
-.. versionadded:: Arrow Columnar Format 1.3
+.. versionadded:: "Arrow Columnar Format 1.3"
Review Comment:
```suggestion
.. versionadded:: Arrow\ Columnar\ Format\ 1.3
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] GH-46942: [Docs] Quote the version argument in versionadded directives [arrow]
Posted by "kou (via GitHub)" <gi...@apache.org>.
kou commented on PR #46997:
URL: https://github.com/apache/arrow/pull/46997#issuecomment-3039896727
@github-actions crossbow submit preview-docs
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] GH-46942: [Docs] Quote the version argument in versionadded directives [arrow]
Posted by "kou (via GitHub)" <gi...@apache.org>.
kou commented on PR #46997:
URL: https://github.com/apache/arrow/pull/46997#issuecomment-3042549427
@github-actions crossbow submit preview-docs
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] GH-46942: [Docs] Quote the version argument in versionadded directives [arrow]
Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #46997:
URL: https://github.com/apache/arrow/pull/46997#issuecomment-3039915467
Revision: 4ebfb82350b1be2b0b7dfbcedd7fb7d71da5e41a
Submitted crossbow builds: [ursacomputing/crossbow @ actions-dbff56dfa1](https://github.com/ursacomputing/crossbow/branches/all?query=actions-dbff56dfa1)
|Task|Status|
|----|------|
|preview-docs|[](https://github.com/ursacomputing/crossbow/actions/runs/16091763755/job/45409525234)|
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] GH-46942: [Docs] Replace the directive versionadded with note [arrow]
Posted by "kou (via GitHub)" <gi...@apache.org>.
kou merged PR #46997:
URL: https://github.com/apache/arrow/pull/46997
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] GH-46942: [Docs] Replace the directive versionadded with note [arrow]
Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #46997:
URL: https://github.com/apache/arrow/pull/46997#issuecomment-3124871208
Revision: 71e29e8c6cd7a61e8291cd3c325ac1db59327201
Submitted crossbow builds: [ursacomputing/crossbow @ actions-123f37be5d](https://github.com/ursacomputing/crossbow/branches/all?query=actions-123f37be5d)
|Task|Status|
|----|------|
|preview-docs|[](https://github.com/ursacomputing/crossbow/actions/runs/16557513986/job/46821227964)|
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] GH-46942: [Docs] Quote the version argument in versionadded directives [arrow]
Posted by "mootari (via GitHub)" <gi...@apache.org>.
mootari commented on PR #46997:
URL: https://github.com/apache/arrow/pull/46997#issuecomment-3041238016
<img width="751" alt="Bildschirmfoto 2025-07-06 um 11 14 11" src="https://github.com/user-attachments/assets/f0835fe9-151b-4abe-92fa-211b57ae9f53" />
Well, [that didn't work](http://crossbow.voltrondata.com/pr_docs/46997/format/Columnar.html#variadic-buffers). I'll give escaped whitespaces a try, otherwise it's straight on to `.. note::`.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] GH-46942: [Docs] Quote the version argument in versionadded directives [arrow]
Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #46997:
URL: https://github.com/apache/arrow/pull/46997#issuecomment-3042551541
Revision: 46ac00f1ad9957d4178cbe28db159f231d26d283
Submitted crossbow builds: [ursacomputing/crossbow @ actions-4fa5abe911](https://github.com/ursacomputing/crossbow/branches/all?query=actions-4fa5abe911)
|Task|Status|
|----|------|
|preview-docs|[](https://github.com/ursacomputing/crossbow/actions/runs/16103022402/job/45434621252)|
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] GH-46942: [Docs] Quote the version argument in versionadded directives [arrow]
Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #46997:
URL: https://github.com/apache/arrow/pull/46997#issuecomment-3041243036
```
Only contributors can submit requests to this bot. Please ask someone from the community for help with getting the first commit in.
The Archery job run can be found at: https://github.com/apache/arrow/actions/runs/16097562092
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] GH-46942: [Docs] Replace the directive versionadded with note [arrow]
Posted by "kou (via GitHub)" <gi...@apache.org>.
kou commented on PR #46997:
URL: https://github.com/apache/arrow/pull/46997#issuecomment-3212850415
https://github.com/apache/arrow/pull/47406
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] GH-46942: [Docs] Replace the directive versionadded with note [arrow]
Posted by "conbench-apache-arrow[bot] (via GitHub)" <gi...@apache.org>.
conbench-apache-arrow[bot] commented on PR #46997:
URL: https://github.com/apache/arrow/pull/46997#issuecomment-3162946907
After merging your PR, Conbench analyzed the 4 benchmarking runs that have been run so far on merge-commit c2d2727725eb1cfc74e74a42a858684297e7bad7.
There weren't enough matching historic benchmark results to make a call on whether there were regressions.
The [full Conbench report](https://github.com/apache/arrow/runs/47573872070) has more details.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org