-
Notifications
You must be signed in to change notification settings - Fork 215
Open
Labels
P2contributions wanted!Looking for external contributionsLooking for external contributionsgood first issueGood for newcomersGood for newcomers
Description
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:
- modify pyproject.toml files to enable these rules
- fix errors emerging from enabling these rules
- enable these rules on pyproject.toml template: https://github.com/deepset-ai/haystack-core-integrations/blob/main/scripts/utils/templates/pyproject.toml
I recommend opening more than one PR to ease review but not one for each integration
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
P2contributions wanted!Looking for external contributionsLooking for external contributionsgood first issueGood for newcomersGood for newcomers
Type
Projects
Status
Todo