-
-
Notifications
You must be signed in to change notification settings - Fork 2
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.
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
build(deps): add pydoclint #228
Conversation
Reviewer's Guide by SourceryThis pull request introduces pydoclint to the pre-commit hooks and updates isort to version 6.0.0. Additionally, it renames some of the make commands to be more descriptive and adds a return to the enter method of the DisposableConnection class. Class diagram showing updated DisposableConnection classclassDiagram
class DisposableConnection {
-_database
+__enter__() DisposableConnection
}
note for DisposableConnection "Added return type annotation for __enter__ method"
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hey @cesarcoatl - I've reviewed your changes - here's some feedback:
Overall Comments:
- The removal of
files: ^src/
from the pylint hook will cause it to run on all Python files in the repository. Was this intentional? Consider keeping the src/ restriction if other Python files (like scripts or tests) don't need to be linted.
Here's what I looked at during the review
- 🟡 General issues: 2 issues found
- 🟢 Security: all looks good
- 🟢 Testing: all looks good
- 🟢 Complexity: all looks good
- 🟢 Documentation: all looks good
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
language: system | ||
files: ^src/ | ||
types: [python] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
suggestion (performance): Removing the src/ directory constraint for pylint might impact pre-commit hook performance
Consider keeping the files constraint to limit pylint to only the relevant source files
Suggested implementation:
name: pylint
entry: pylint
language: system
files: ^src/
types: [python]
Note: If your source code is not in a src/ directory, you should adjust the files pattern to match your project's structure (e.g., ^your_package/ or similar).
Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
Summary by Sourcery
Add pydoclint to the pre-commit hooks and update isort.
Build:
CI: