-
Notifications
You must be signed in to change notification settings - Fork 3.8k
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
base: main
Are you sure you want to change the base?
Conversation
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?
or
See also: |
|
@github-actions crossbow submit preview-docs |
Revision: 4ebfb82 Submitted crossbow builds: ursacomputing/crossbow @ actions-dbff56dfa1
|
![]() Well, that didn't work. I'll give escaped whitespaces a try, otherwise it's straight on to |
@github-actions crossbow submit preview-docs |
|
@github-actions crossbow submit preview-docs |
Revision: 46ac00f Submitted crossbow builds: ursacomputing/crossbow @ actions-4fa5abe911
|
Rationale for this change
The Sphinx directive
versionadded
expects aversion
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.