GH-49503: [Docs][Python] Documenting .pxi doctests are tested via lib.pyx#49515
Merged
Conversation
|
|
github-actions
Bot
added
Component: Documentation
awaiting review
bhavanaeh
commented
Mar 15, 2026
bhavanaeh
changed the title
|
|
github-actions
Bot
added
awaiting committer review
Member
|
@github-actions crossbow submit preview-docs |
|
Revision: ecff1a1 Submitted crossbow builds: ursacomputing/crossbow @ actions-bfd9f4b8a6
|
AlenkaF
reviewed
Mar 19, 2026
Member
AlenkaF
left a comment
AlenkaF
left a comment
There was a problem hiding this comment.
Thanks for the PR!
Adding one comment from my side.
Contributor
Author
|
@AlenkaF thanks for the comment, addressed! |
AlenkaF
approved these changes
Mar 20, 2026
AlenkaF
reviewed
Mar 20, 2026
|
After merging your PR, Conbench analyzed the 2 benchmarking runs that have been run so far on merge-commit 8a8e574. There were no benchmark performance regressions. 🎉 The full Conbench report has more details. It also includes information about 9 possible false positives for unstable benchmarks that are known to sometimes produce them. |
thisisnic
pushed a commit
to thisisnic/arrow
that referenced
this pull request
Apr 6, 2026
…ia lib.pyx (apache#49515) ### Rationale for this change Running `python -m pytest --doctest-cython` directly on `.pxi` files doesn't work because Cython `.pxi` files are included in `.pyx` files at compile time. This isn't documented, which could _potentially_ confuse contributors. Please see discussion in apache#49279 (comment) by @ AlenkaF for additional context. ### What changes are included in this PR? Added a `note` to the Doctest section of the Developing PyArrow documentation explaining that: - `.pxi` files cannot be tested directly with `--doctest-cython` - Doctests should be run on the `.pyx` file they are included in (e.g., `lib.pyx`) - Errors will appear under the `.pyx` file, not the original `.pxi` filename ### Are these changes tested? Documentation-only change. No code changes. ### Are there any user-facing changes? No. * GitHub Issue: apache#49503 Lead-authored-by: Bhavana Sundar <bhavana7899@gmail.com> Co-authored-by: Alenka Frim <AlenkaF@users.noreply.github.com> Signed-off-by: AlenkaF <frim.alenka@gmail.com>
Mottl
pushed a commit
to Mottl/arrow
that referenced
this pull request
May 26, 2026
…ia lib.pyx (apache#49515) ### Rationale for this change Running `python -m pytest --doctest-cython` directly on `.pxi` files doesn't work because Cython `.pxi` files are included in `.pyx` files at compile time. This isn't documented, which could _potentially_ confuse contributors. Please see discussion in apache#49279 (comment) by @ AlenkaF for additional context. ### What changes are included in this PR? Added a `note` to the Doctest section of the Developing PyArrow documentation explaining that: - `.pxi` files cannot be tested directly with `--doctest-cython` - Doctests should be run on the `.pyx` file they are included in (e.g., `lib.pyx`) - Errors will appear under the `.pyx` file, not the original `.pxi` filename ### Are these changes tested? Documentation-only change. No code changes. ### Are there any user-facing changes? No. * GitHub Issue: apache#49503 Lead-authored-by: Bhavana Sundar <bhavana7899@gmail.com> Co-authored-by: Alenka Frim <AlenkaF@users.noreply.github.com> Signed-off-by: AlenkaF <frim.alenka@gmail.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Rationale for this change
Running
python -m pytest --doctest-cythondirectly on.pxifiles doesn't work because Cython.pxifiles are included in.pyxfiles at compile time. This isn't documented, which could potentially confuse contributors.Please see discussion in #49279 (comment) by @AlenkaF for additional context.
What changes are included in this PR?
Added a
noteto the Doctest section of the Developing PyArrow documentation explaining that:.pxifiles cannot be tested directly with--doctest-cython.pyxfile they are included in (e.g.,lib.pyx).pyxfile, not the original.pxifilenameAre these changes tested?
Documentation-only change. No code changes.
Are there any user-facing changes?
No.