Skip to content

Commit ce75da8

Browse files
committed
docs: clarifying all .pxi files are included into lib.pyx
1 parent ecff1a1 commit ce75da8

1 file changed

Lines changed: 3 additions & 3 deletions

File tree

docs/source/developers/python/development.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -198,13 +198,13 @@ install the `pytest-cython <https://github.com/lgpage/pytest-cython>`_ plugin.
198198
.. note::
199199
Cython ``.pxi`` files are included in ``.pyx`` files at compile time,
200200
so ``--doctest-cython`` cannot be run directly on ``.pxi`` files.
201-
Instead, run doctests on the ``.pyx`` file they are included in, for
202-
example ``lib.pyx``::
201+
In PyArrow, all ``.pxi`` files are included into ``lib.pyx``, so run
202+
doctests on that file::
203203

204204
$ python -m pytest --doctest-cython pyarrow/lib.pyx
205205

206206
Any doctest errors originating from ``.pxi`` files will appear under
207-
the corresponding ``.pyx`` file, not the original ``.pxi`` filename.
207+
``lib.pyx``, not the original ``.pxi`` filename.
208208

209209
Testing Documentation Examples
210210
-------------------------------

0 commit comments

Comments
 (0)