Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

doc: adding docstring linting based on ruff #7463

Merged
merged 7 commits into from
Apr 23, 2024
Merged

doc: adding docstring linting based on ruff #7463

merged 7 commits into from
Apr 23, 2024

Conversation

davidsbatista
Copy link
Contributor

@davidsbatista davidsbatista commented Apr 4, 2024 •
edited
Loading

Related Issues

Fixes #7096

Proposed Changes:

Use ruff to detect the following issues:

built-in shadowing

"A001", # builtin-variable-shadowing
"A002", # builtin-argument-shadowing
"A003", # builtin-attribute-shadowing

docstring rules

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

@github-actions github-actions bot added topic:build/distribution topic:CI 2.x Related to Haystack v2.0 type:documentation Improvements on the docs labels Apr 4, 2024
@davidsbatista davidsbatista mentioned this pull request Apr 4, 2024
Merged
@coveralls
Copy link
Collaborator

coveralls commented Apr 4, 2024 •
edited
Loading

Pull Request Test Coverage Report for Build 8803582794

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage increased (+0.002%) to 90.108%
Totals Coverage Status
Change from base Build 8803543187: 0.002%
Covered Lines: 6285
Relevant Lines: 6975
💛 - Coveralls

@masci masci added the ignore-for-release-notes PRs with this flag won't be included in the release notes. label Apr 8, 2024
@masci masci mentioned this pull request Apr 8, 2024
Closed
@masci masci force-pushed the docstrings-linting branch from 2ac761c to 7997915 Compare April 12, 2024 07:10
@masci masci mentioned this pull request Apr 12, 2024
Merged
@davidsbatista davidsbatista marked this pull request as ready for review April 23, 2024 16:04
@davidsbatista davidsbatista requested a review from a team as a code owner April 23, 2024 16:04
@davidsbatista davidsbatista requested review from masci and removed request for a team April 23, 2024 16:04
@davidsbatista davidsbatista changed the title docstring linting monitoring doc: adding docstring linting based on ruff Apr 23, 2024
masci
masci approved these changes Apr 23, 2024
View reviewed changes
Copy link
Contributor

@masci masci left a comment

Choose a reason for hiding this comment

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

🚢

@davidsbatista davidsbatista merged commit 958f1eb into main Apr 23, 2024
40 checks passed
@davidsbatista davidsbatista deleted the docstrings-linting branch April 23, 2024 16:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@masci masci masci approved these changes

Assignees
No one assigned
Labels
2.x Related to Haystack v2.0 ignore-for-release-notes PRs with this flag won't be included in the release notes. proposal topic:build/distribution topic:CI topic:core topic:docker topic:tests type:documentation Improvements on the docs
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Docstring linting
3 participants
@davidsbatista @coveralls @masci