GH-49503: [Docs][Python] Document .pxi doctests#49516
Open
BillionClaw wants to merge 1 commit intoapache:mainfrom
Open
GH-49503: [Docs][Python] Document .pxi doctests#49516BillionClaw wants to merge 1 commit intoapache:mainfrom
BillionClaw wants to merge 1 commit intoapache:mainfrom
Conversation
Add documentation explaining that .pxi file doctests are tested via lib.pyx and that errors surface under lib.pyx rather than the original .pxi filename. Closes apache#49503
|
|
github-actions
bot
added
Component: Documentation
awaiting review
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.
Description
This PR adds documentation explaining how to test doctests in
.pxifiles.The documentation now clarifies that:
.pxifile doctests are actually tested vialib.pyxpython -m pytest --doctest-cython path/to/lib.pyx.pxifiles will surface underlib.pyxin the test output, not under the original.pxifilenameRelated Issue
Closes #49503
Changes
.. note::block indocs/source/developers/python/development.rstunder the Doctest section