Skip to content

Add docstring checks to RUFF #218

Description

@jaredsnyder

It would be great to activate the pydocstyle docstring "D" rules in Ruff, but Ruff currently doesn't support sphinx formatting for docstrings. There is an open ticket (astral-sh/ruff#6606) and if/when it gets merged we should add docstring checks.

An open issue is whether we want to require docstrings in the tests folder. I think it would be nice but given the sheer number of functions that need docstrings and the questionable utility it might not be worth it.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Fields

    Priority

    None yet

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions