Skip to content

chore: enforce ruff docstring rules in integrations 11-20 (deepeval, elasticsearch, faiss, fastembed, firecrawl, github, google_genai, hanlp, jina, kreuzberg)#3009

Merged
julian-risch merged 1 commit intomainfrom
feat/docstring-ruff-rules-batch2
Mar 23, 2026
Merged

chore: enforce ruff docstring rules in integrations 11-20 (deepeval, elasticsearch, faiss, fastembed, firecrawl, github, google_genai, hanlp, jina, kreuzberg)#3009
julian-risch merged 1 commit intomainfrom
feat/docstring-ruff-rules-batch2

Conversation

@julian-risch
Copy link
Copy Markdown
Member

@julian-risch julian-risch commented Mar 20, 2026

Related Issues

Part 2/5 of #2947

Proposed Changes:

  • Adds ruff pydocstyle rules D102, D103, D205, D209, D213, D417, D419 to pyproject.toml for 10 integrations: deepeval, elasticsearch, faiss, fastembed, firecrawl, github, google_genai, hanlp, jina, kreuzberg
  • Fixes all resulting docstring violations (primarily D205 — blank line required between summary and description)
  • D213/D209 violations were auto-fixed by ruff --fix; D205 violations fixed manually

How did you test it?

Ran for each integration:

  • hatch run fmt-check — all pass
  • hatch run test:types — all pass
  • hatch run test:unit — all pass

Notes for the reviewer

This is batch 2 of the docstring rules enforcement. Batch 1 (aimlapi through cometapi) was #3008.
I skipped two archived google integrations.
As mentioned in #3008, I thought about adding D107, which is not mentioned in the issue. D107 checks that init method definitions have docstrings. I could open one separate PR that adds D107 to all integrations and one PR to add it to Haystack if we agree its beneficial. For consistency it makes sense but there is not much value added but the __init__ docstrings so it's not of importance.

Checklist

…19) in integrations 11-20

Adds D102, D103, D205, D209, D213, D417, D419 ruff rules to pyproject.toml
for: deepeval, elasticsearch, faiss, fastembed, firecrawl, github, google_genai,
hanlp, jina, kreuzberg. Fixes all resulting docstring violations.

Part of #2947

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Copy link
Copy Markdown
Contributor

@sjrl sjrl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

@julian-risch julian-risch merged commit 4d1adb4 into main Mar 23, 2026
67 checks passed
@julian-risch julian-risch deleted the feat/docstring-ruff-rules-batch2 branch March 23, 2026 08:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants