Skip to content

DOC: Validate reST directives in docstrings #27629

Closed
@albertvillanova

Description

@albertvillanova

Code Sample, a copy-pastable example if possible

python scripts/validate_docstrings.py pandas.Series.item

Problem description

As pointed out by PR #27621, scripts/validate_docstrings.py does not detect dosctrings containing a reST directive without two colons.

Expected Output

The script should report an error in this case.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions