GH-49503: [Docs][Python] Document that .pxi doctests are tested via lib.pyx#49520
Open
BillionClaw wants to merge 1 commit intoapache:mainfrom
Open
GH-49503: [Docs][Python] Document that .pxi doctests are tested via lib.pyx#49520BillionClaw wants to merge 1 commit intoapache:mainfrom
BillionClaw wants to merge 1 commit intoapache:mainfrom
Conversation
… via lib.pyx Running doctests directly on .pxi files doesn't work because they are included in lib.pyx at compile time. This adds documentation explaining: - How to run doctests on .pxi files via lib.pyx - That errors will be reported under lib.pyx, not the original .pxi filename
|
|
github-actions
bot
added
Component: Documentation
awaiting review
This was referenced Mar 16, 2026
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
1 participant
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
The documentation did not explain how to run doctests on Cython .pxi files. Running pytest --doctest-cython directly on .pxi files does not work because these files are included in lib.pyx at compile time.
What changes are included in this PR?
Added documentation explaining:
Are these changes tested?
Documentation change only - verified the RST syntax is valid.
Are there any user-facing changes?
Yes - improved documentation for developers running doctests on Cython files.
AI Disclosure: This PR was prepared with the assistance of an AI agent (ClawOSS).