[jira] [Created] (ARROW-16018) [Doc][Python] Run doctests on Python docstring examples

["Joris Van den Bossche (Jira)" <ji...@apache.org>]

Joris Van den Bossche created ARROW-16018:
---------------------------------------------

             Summary: [Doc][Python] Run doctests on Python docstring examples
                 Key: ARROW-16018
                 URL: https://issues.apache.org/jira/browse/ARROW-16018
             Project: Apache Arrow
          Issue Type: Test
          Components: Documentation, Python
            Reporter: Joris Van den Bossche


We start to add more and more examples to the docstrings of Python methods (ARROW-15367), and so we could use the doctest functionality to ensure that those examples are actually correct (and keep being correct).

Pytest has integration for doctests (https://docs.pytest.org/en/6.2.x/doctest.html), and so you can do:

{code}
pytest python/pyarrow --doctest-modules
{code}

This currently fails for me because not having pyarrow.cuda, so we will need to find some ways to automatically skips those parts if not available.



--
This message was sent by Atlassian Jira
(v8.20.1#820001)