Skip to content

Enforce Ruff docstring rules #2947

@anakin87

Description

@anakin87

In Haystack, we have these ruff rules enabled for docstrings:

  "D102",   # Missing docstring in public method
  "D103",   # Missing docstring in public function
  "D205",   # 1 blank line required between summary line and description
  "D209",   # Closing triple quotes go to new line
  "D213",   # summary lines must be positioned on the second physical line of the docstring
  "D417",   # undocumented-parameter
  "D419",   # undocumented-returns

We should do something similar on core integrations:

I recommend opening more than one PR to ease review but not one for each integration

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    Status

    Todo

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions