Skip to content

DOC, TST: check docstrings in doc/*rst files #14970

@mattip

Description

@mattip

We recently added the ability for refguide-check to test the *.rst files in doc and below. There are failures that should be fixed. Some hints to run the tests and find the broken docstrings:

  • the docstrings much match the numpy version, so you should install it locally
  • run the refguide-check python tools/refguide-check.py --rst

Currently for me this prints out many failures, the summary is below

ERROR:  failed checking doc/source/reference/maskedarray.baseclass.rst
        failed checking doc/source/reference/arrays.ndarray.rst
        failed checking doc/source/reference/routines.polynomials.classes.rst
        failed checking doc/source/reference/arrays.datetime.rst
        failed checking doc/source/reference/arrays.nditer.rst
        failed checking doc/source/reference/arrays.dtypes.rst
        failed checking doc/source/reference/arrays.indexing.rst
        failed checking doc/source/reference/distutils.rst
        failed checking doc/source/reference/arrays.classes.rst
        failed checking doc/source/reference/c-api/coremath.rst
        failed checking doc/source/f2py/getting-started.rst
        failed checking doc/source/user/c-info.python-as-glue.rst
        failed checking doc/source/user/quickstart.rst

When all the errors are fixed, we should enable this check on CI to make sure new errors do not crop up.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions