Repository navigation
chore: enforce ruff docstring rules in remaining integrations - #4175
julian-risch merged 1 commit into
Conversation
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
|
Heads-up for maintainers This PR is from a fork and touches integrations whose integration tests require API keys. Affected integrations:
Please run the integration tests locally ( |
Coverage report (arcadedb)Click to see where and how coverage changed
This report was generated by python-coverage-comment-action |
||||||||||||||||||||||||
Coverage report (litellm)Click to see where and how coverage changed
This report was generated by python-coverage-comment-action |
||||||||||||||||||||||||
Coverage report (amazon_sagemaker)Click to see where and how coverage changed
This report was generated by python-coverage-comment-action |
||||||||||||||||||||||||
|
Hi @A2ELAOUDI, thanks a lot for your contribution! 🙏 We noticed that the Contributor License Agreement (CLA) check ( To get your PR reviewed, please sign the CLA via the link in the |
|
Thanks for signing the CLA, @A2ELAOUDI! 🎉 This PR is now ready for review again and the reviewer has been re-assigned. |
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,Dadded to the tests per-file-ignores (matching the other integrations), one D205 fix.arcadedb: rules enabled, seven D205 fixes indocument_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 underintegrations/do too.How did you test it?
ruff check .andruff format --check .pass in each of the five integrations.hatch run test:unitpasses 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
fix:,feat:,build:,chore:,ci:,docs:,style:,refactor:,perf:,test:.