Skip to content

chore: enforce ruff docstring rules in remaining integrations - #4175

Merged
julian-risch merged 1 commit into
deepset-ai:mainfrom
A2ELAOUDI:chore/2947-docstring-rules-remaining-integrations
Oct 30, 2026
Merged

julian-risch merged 1 commit into
deepset-ai:mainfrom
A2ELAOUDI:chore/2947-docstring-rules-remaining-integrations

Conversation

@A2ELAOUDI

Copy link
Copy Markdown
Contributor

Related Issues

Proposed Changes:

Enables the docstring rules from #2947 (D102, D103, D205, D209, D213, D417, D419) in the last five integrations that did not have them yet, following the same pattern as #3008–#3012:

  • amazon_sagemaker: rules enabled, D added to the tests per-file-ignores (matching the other integrations), one D205 fix.
  • arcadedb: rules enabled, seven D205 fixes in document_store.py (blank line after the summary; one two-line summary condensed to a single line, and a missing period added).
  • azure_doc_intelligence, azure_form_recognizer: rules enabled, no violations.
  • litellm: rules enabled, five D213 fixes (summary moved to the second line).

The new-integration template (scripts/utils/templates/pyproject.toml) already enables these rules. With this PR, all integrations under integrations/ do too.

How did you test it?

  • ruff check . and ruff format --check . pass in each of the five integrations.
  • hatch run test:unit passes for amazon_sagemaker (12 passed), arcadedb (137 passed) and litellm (28 passed). The azure integrations only had pyproject changes.

Notes for the reviewer

Only docstrings and ruff config changed. There are no code changes.

Checklist

Adds D102, D103, D205, D209, D213, D417, D419 to the ruff config of
amazon_sagemaker, arcadedb, azure_doc_intelligence, azure_form_recognizer
and litellm, and fixes the resulting docstring violations.

Part of deepset-ai#2947
@A2ELAOUDI
A2ELAOUDI requested a review from a team as a code owner October 30, 2026 12:00
@A2ELAOUDI
A2ELAOUDI requested review from julian-risch and removed request for a team October 30, 2026 12:00
@CLAassistant

CLAassistant commented Oct 30, 2026 •

Copy link
Copy Markdown

CLA assistant check
All committers have signed the CLA.

@github-actions

Copy link
Copy Markdown
Contributor

Heads-up for maintainers

This PR is from a fork and touches integrations whose integration tests require API keys.
Those tests are skipped in CI because fork PRs don't have access to repo secrets for security reasons.

Affected integrations:

  • arcadedb
  • azure_doc_intelligence
  • azure_form_recognizer
  • litellm

Please run the integration tests locally (hatch run test:integration inside each folder) before approving.

@github-actions

Copy link
Copy Markdown
Contributor

Coverage report (arcadedb)

Click to see where and how coverage changed

FileStatementsMissingCoverageCoverage
(new stmts)
Lines missing
  integrations/arcadedb/src/haystack_integrations/document_stores/arcadedb
  document_store.py
Project Total  

This report was generated by python-coverage-comment-action

@github-actions

Copy link
Copy Markdown
Contributor

Coverage report (litellm)

Click to see where and how coverage changed

FileStatementsMissingCoverageCoverage
(new stmts)
Lines missing
  integrations/litellm/src/haystack_integrations/components/generators/litellm/chat
  chat_generator.py
Project Total  

This report was generated by python-coverage-comment-action

@github-actions

Copy link
Copy Markdown
Contributor

Coverage report (amazon_sagemaker)

Click to see where and how coverage changed

FileStatementsMissingCoverageCoverage
(new stmts)
Lines missing
  integrations/amazon_sagemaker/src/haystack_integrations/components/generators/amazon_sagemaker
  sagemaker.py
Project Total  

This report was generated by python-coverage-comment-action

@github-actions

Copy link
Copy Markdown
Contributor

Coverage report (azure_doc_intelligence)

This PR does not seem to contain any modification to coverable code.

@github-actions

Copy link
Copy Markdown
Contributor

Coverage report (azure_form_recognizer)

This PR does not seem to contain any modification to coverable code.

@HaystackBot

Copy link
Copy Markdown
Contributor

Hi @A2ELAOUDI, thanks a lot for your contribution! 🙏

We noticed that the Contributor License Agreement (CLA) check (license/cla) hasn't passed yet, so we've temporarily moved this PR to draft and paused the review assignment.

To get your PR reviewed, please sign the CLA via the link in the license/cla check below (or in the CLA bot comment). As soon as the check turns green, this PR will automatically be marked ready for review again and a reviewer will be re-assigned.

@HaystackBot
HaystackBot removed the request for review from julian-risch October 30, 2026 13:24
@HaystackBot HaystackBot added the cla-pending PR is in draft until the contributor signs the CLA label Oct 30, 2026
@HaystackBot
HaystackBot marked this pull request as draft October 30, 2026 13:24
@HaystackBot
HaystackBot marked this pull request as ready for review October 30, 2026 15:38
@HaystackBot HaystackBot removed the cla-pending PR is in draft until the contributor signs the CLA label Oct 30, 2026
@HaystackBot

Copy link
Copy Markdown
Contributor

Thanks for signing the CLA, @A2ELAOUDI! 🎉 This PR is now ready for review again and the reviewer has been re-assigned.

@julian-risch julian-risch left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thank you @A2ELAOUDI !

@julian-risch
julian-risch merged commit dbe0563 into deepset-ai:main Oct 30, 2026
50 of 54 checks passed
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.

Enforce Ruff docstring rules

4 participants