Skip to content

GH-49503: [Docs][Python] Document .pxi doctests #49516

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

Closed
BillionClaw wants to merge 1 commit into from
+10 −0
Closed

GH-49503: [Docs][Python] Document .pxi doctests #49516

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 10 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,16 @@ 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::

When running doctests for ``.pxi`` files, they are actually tested via
``lib.pyx``. Use the following command pattern::

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

Any doctest errors in ``.pxi`` files will surface under ``lib.pyx`` in
the test output, not under the original ``.pxi`` filename.

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

Expand Down