Skip to content

Ensure that docstrings pass numpydoc validation #20308

Closed
#21468
Closed
Ensure that docstrings pass numpydoc validation#20308
#21468
Labels
DocumentationSprintgood first issueEasy with clear instructions to resolve
@thomasjpfan

Description

@thomasjpfan
thomasjpfan
opened on Jun 21, 2021
  1. Make sure you have the development dependencies and documentation dependencies installed.
  2. Pick an estimator from the list below and leave a comment saying you are going to work on it. This way we can keep track of what everyone is working on.
  3. Remove the estimator from the list at:

    scikit-learn/maint_tools/test_docstrings.py

    Line 11 in bb6117b

    DOCSTRING_IGNORE_LIST = [
  4. Let's say you picked StandardScaler, run numpydoc validation as follows (Adding the - at the end helps with the regex).
pytest maint_tools/test_docstrings.py -k StandardScaler-
  1. If you see failing test, please fix them by following the recommendation provided by the failing test.
  2. If you see all the tests past, you do not need to do any additional changes.
  3. Commit your changes.
  4. Open a Pull Request with an opening message Addresses #20308. Note that each item should be submitted in a separate Pull Request.
  5. Include the estimator name in the title of the pull request. For example: "DOC Ensures that StandardScaler passes numpydoc validation".

Metadata

Metadata

Assignees

No one assigned

    Labels

    DocumentationSprintgood first issueEasy with clear instructions to resolve

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions