Skip to content

GH-46942: [Docs] Quote the version argument in versionadded directives #46997

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

mootari
Copy link

@mootari mootari commented Jul 5, 2025

Rationale for this change

The Sphinx directive versionadded expects a version argument and an optional description of the change (docs). 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.

Copy link

github-actions bot commented Jul 5, 2025

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}

See also:

@mootari mootari changed the title Quote the version argument in versionadded directives GH-46942: [Docs] Quote the version argument in versionadded directives Jul 5, 2025
Copy link

github-actions bot commented Jul 5, 2025

⚠️ GitHub issue #46942 has been automatically assigned in GitHub to PR creator.

@kou
Copy link
Member

kou commented Jul 5, 2025

@github-actions crossbow submit preview-docs

Copy link

github-actions bot commented Jul 5, 2025

Revision: 4ebfb82

Submitted crossbow builds: ursacomputing/crossbow @ actions-dbff56dfa1

Task Status
preview-docs GitHub Actions

@mootari
Copy link
Author

mootari commented Jul 6, 2025

Bildschirmfoto 2025-07-06 um 11 14 11

Well, that didn't work. I'll give escaped whitespaces a try, otherwise it's straight on to .. note::.

@mootari
Copy link
Author

mootari commented Jul 6, 2025

@github-actions crossbow submit preview-docs

Copy link

github-actions bot commented Jul 6, 2025

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

@kou
Copy link
Member

kou commented Jul 6, 2025

@github-actions crossbow submit preview-docs

Copy link

github-actions bot commented Jul 6, 2025

Revision: 46ac00f

Submitted crossbow builds: ursacomputing/crossbow @ actions-4fa5abe911

Task Status
preview-docs GitHub Actions

@pitrou pitrou marked this pull request as ready for review July 16, 2025 12:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Docs] versionadded directive used incorrectly in Columnar Format docs
2 participants