Skip to content

GH-49503: [Docs][Python] Documenting .pxi doctests are tested via lib.pyx #49515

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.

Sign up for GitHub

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

Merged
AlenkaF merged 3 commits into from
Mar 20, 2026
Merged

GH-49503: [Docs][Python] Documenting .pxi doctests are tested via lib.pyx #49515

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ecff1a1
GH-49503: [Python][Doc] Document that .pxi doctests are tested via li…
bhavanaeh Mar 15, 2026
ce75da8
docs: clarifying all .pxi files are included into lib.pyx
bhavanaeh Mar 20, 2026
cacc0bc
Update docs/source/developers/python/development.rst
AlenkaF Mar 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions docs/source/developers/python/development.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -195,6 +195,17 @@ for ``.py`` files or
for ``.pyx`` and ``.pxi`` files. In this case you will also need to
install the `pytest-cython <https://github.com/lgpage/pytest-cython>`_ plugin.

.. note::
Cython ``.pxi`` files are included in ``.pyx`` files at compile time,
so ``--doctest-cython`` cannot be run directly on ``.pxi`` files.
In PyArrow, all ``.pxi`` files are included into ``lib.pyx``, so run
doctests on that file::

$ python -m pytest --doctest-cython path/to/lib.pyx

Any doctest errors originating from ``.pxi`` files will appear under
``lib.pyx``, not the original ``.pxi`` filename.

Testing Documentation Examples
-------------------------------

Expand Down
Loading