Skip to content

DOC: Validate that items in See Also section do not start by pandas. #23136

Closed
@datapythonista

Description

@datapythonista

scripts/validate_docstrings.py validates that the content of a docstring follows our standards. There are still some of those standards that the script does not validate, and this gives the users the wrong impression that the docstring is all right, when it's not really the case. All the missing validations are listed in #20298.

One of the standards is that the items in the See Also section should not start by pandas. as this is already configured in sphinx to be the default. So, instead of pandas.DataFrame.head : Return the first n rows we prefer DataFrame.head : Return the first n rows, as pandas is the default package,

For this issue is required:

  • Change scripts/validate_docstings.py to give an error if the items have the prefix pandas..
  • Add tests in scripts/tests/test_validate_docstrings.py
  • Run the script for all docstrings (i.e. ./scripts/validate_docstings.py) and check in the resulting report how many of the docstrings in pandas have these imports. Add as a comment in this issue the list, unless they are a reduced number, in which case they can be directly fixed in the same PR.

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