Skip to content

Replace darglint with ruff DOC rules. #4454

@Lendemor

Description

@Lendemor

Darglint is not maintained anymore, and is very slow.

Alternative to covers the docstring checks:

  • pydoclint: Is actively maintained and the rules mostly make sense, but they are not selectable, so it's all or nothing.
  • ruff DOC rules: These rules are inspired by pydoclint but will give us the flexibility of ruff in selecting the rules we want to apply.

Subset of the rules we need enabled in ruff, before we can remove darglint:

  • DOC101
  • DOC102
  • DOC103
  • DOC104
  • DOC111
  • DOC201
  • DOC202
  • DOC402
  • DOC403
  • DOC501
  • DOC502

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementAnything you want improved

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions