You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@arrow.apache.org by "mootari (via GitHub)" <gi...@apache.org> on 2025/06/30 10:28:00 UTC
[I] versionadded directive used incorrectly in Columnar Format docs [arrow]
mootari opened a new issue, #46942:
URL: https://github.com/apache/arrow/issues/46942
### Describe the bug, including details regarding any error messages, version, and platform.
The page [Arrow Columnar Format](https://arrow.apache.org/docs/19.0/format/Columnar.html) ([source](https://github.com/apache/arrow/blob/587b3fcad5ae4524411714c80a1479ff9a435508/docs/source/format/Columnar.rst?plain=1#L485)) use [Sphinx' `versionadded` directive](https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-versionadded) to annotate when a particular section was introduced.
However, the directive expects only the first argument to be the version and treats the remainder as brief explanation, resulting in the following rendered output:
> **_New in version Arrow:_** Columnar Format 1.3
### Component(s)
Documentation
--
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: issues-unsubscribe@arrow.apache.org.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [I] versionadded directive used incorrectly in Columnar Format docs [arrow]
Posted by "mootari (via GitHub)" <gi...@apache.org>.
mootari commented on issue #46942:
URL: https://github.com/apache/arrow/issues/46942#issuecomment-3018739256
> What would be your expectation?
I'd either expect
> **_New in version Arrow Columnar Format 1.3_**
or (to account for the directive's limitations)
> **_New in version 1.3_**
The way it's currently formatted makes "Arrow" appear like a version placeholder, and the description suggests that "Columnar Format 1.3" is the thing being introduced (which may be technically correct but is arguably not the intended message).
If the extended specifier is needed, then maybe `versionadded` is not a good fit here?
--
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: [I] versionadded directive used incorrectly in Columnar Format docs [arrow]
Posted by "raulcd (via GitHub)" <gi...@apache.org>.
raulcd commented on issue #46942:
URL: https://github.com/apache/arrow/issues/46942#issuecomment-3018749116
Thanks for the clarification, that makes sense to me now, sorry I wasn't really understanding the issue you were raising.
--
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: [I] [Docs] versionadded directive used incorrectly in Columnar Format docs [arrow]
Posted by "AlenkaF (via GitHub)" <gi...@apache.org>.
AlenkaF commented on issue #46942:
URL: https://github.com/apache/arrow/issues/46942#issuecomment-3161262842
Could you try building only the format documentation locally, without any source builds or images?
```
pushd arrow/docs
make format
popd
```
See: https://arrow.apache.org/docs/developers/documentation.html#building-subsections and https://arrow.apache.org/docs/developers/documentation.html#prerequisites (Doxygen should not be needed)
--
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: [I] versionadded directive used incorrectly in Columnar Format docs [arrow]
Posted by "raulcd (via GitHub)" <gi...@apache.org>.
raulcd commented on issue #46942:
URL: https://github.com/apache/arrow/issues/46942#issuecomment-3018647034
Thanks for opening the issue.
We have two different versions, the format version and the library version, see:
https://arrow.apache.org/docs/19.0/format/Versioning.html#format-versioning-and-stability
I think having this as a comment for the format spec is expected. It looks like this:
What would be your expectation?
--
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: [I] [Docs] versionadded directive used incorrectly in Columnar Format docs [arrow]
Posted by "mootari (via GitHub)" <gi...@apache.org>.
mootari commented on issue #46942:
URL: https://github.com/apache/arrow/issues/46942#issuecomment-3035185729
@AlenkaF As far as I can tell I'd have to set up everything to build the docs so that I can verify the change. I'm afraid that doesn't seem like time well spent to me for a four-lines change if the same thing can be accomplished by y'all in a matter of minutes. 😅
--
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: [I] [Docs] versionadded directive used incorrectly in Columnar Format docs [arrow]
Posted by "mootari (via GitHub)" <gi...@apache.org>.
mootari commented on issue #46942:
URL: https://github.com/apache/arrow/issues/46942#issuecomment-3124436968
> I'd have to set up everything to build the docs
Out of curiosity I tried to build the docs through Docker, first via the `continuumio/anaconda3` image (which even after some tweaks still ended up with too many errors to explore any further), then via `docker compose run debian-docs` (which pulled 5GB / 11.5 GB uncompressed of image layers and took a significant amount of time on every run). If there's a sweet spot between those extremes that lets you build "just enough" I haven't found it yet. 😅
--
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: [I] [Docs] versionadded directive used incorrectly in Columnar Format docs [arrow]
Posted by "AlenkaF (via GitHub)" <gi...@apache.org>.
AlenkaF commented on issue #46942:
URL: https://github.com/apache/arrow/issues/46942#issuecomment-3018775879
Thanks for additional explanation, I needed it also =) I think substituting `.. versionadded::` with `New in version` in `format/Columnar.rst` makes sense. It is not used elsewhere as far as I can tell.
--
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: [I] [Docs] versionadded directive used incorrectly in Columnar Format docs [arrow]
Posted by "AlenkaF (via GitHub)" <gi...@apache.org>.
AlenkaF commented on issue #46942:
URL: https://github.com/apache/arrow/issues/46942#issuecomment-3021708052
@mootari are you interested in submitting a PR?
--
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: [I] [Docs] versionadded directive used incorrectly in Columnar Format docs [arrow]
Posted by "kou (via GitHub)" <gi...@apache.org>.
kou closed issue #46942: [Docs] versionadded directive used incorrectly in Columnar Format docs
URL: https://github.com/apache/arrow/issues/46942
--
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: issues-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [I] [Docs] versionadded directive used incorrectly in Columnar Format docs [arrow]
Posted by "AlenkaF (via GitHub)" <gi...@apache.org>.
AlenkaF commented on issue #46942:
URL: https://github.com/apache/arrow/issues/46942#issuecomment-3036298139
That makes sense! 😄 If you're interested, you can also make the change directly in the GitHub UI using the edit button (probably from your fork) on the source page. The CI and docs preview build will then automatically verify the result.
--
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: [I] [Docs] versionadded directive used incorrectly in Columnar Format docs [arrow]
Posted by "kou (via GitHub)" <gi...@apache.org>.
kou commented on issue #46942:
URL: https://github.com/apache/arrow/issues/46942#issuecomment-3162050460
Issue resolved by pull request 46997
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: [I] [Docs] versionadded directive used incorrectly in Columnar Format docs [arrow]
Posted by "mootari (via GitHub)" <gi...@apache.org>.
mootari commented on issue #46942:
URL: https://github.com/apache/arrow/issues/46942#issuecomment-3018828114
Apologies for the initial lack of detail, I'll keep that in mind for future issues. 🙏🏻
--
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: [I] versionadded directive used incorrectly in Columnar Format docs [arrow]
Posted by "raulcd (via GitHub)" <gi...@apache.org>.
raulcd commented on issue #46942:
URL: https://github.com/apache/arrow/issues/46942#issuecomment-3018647405
cc @AlenkaF
--
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: [I] [Docs] versionadded directive used incorrectly in Columnar Format docs [arrow]
Posted by "kou (via GitHub)" <gi...@apache.org>.
kou commented on issue #46942:
URL: https://github.com/apache/arrow/issues/46942#issuecomment-3021312826
We may be able to use `.. info:: New in version Arrow Columnar Format 1.4` for this.
--
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