-
Notifications
You must be signed in to change notification settings - Fork 9
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
Ruff #23
Ruff #23
Conversation
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.
I'm surprised there are no pydocstyle changes, given that the original pydocstyle contains a lot of bugs that prevent detection of issues. Do you need to add some kind of configuration setting to enable pydocstyle checking?
I'll do that in a separate PR. The library itself didn't have many docstrings for the classes and functions and I haven't had the time to go through and add all of them. |
README still references the old tools |
@adamjstewart I made some updates and fixed the actions. Note that |
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.
Surprised no code changes were required, I guess the repo is just smaller and simpler than TorchGeo.
It's because I don't have pydocstyle enabled. When I do that's going to be a huge PR to fix 305 errors lol |
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.
it looks fine to me :D
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.
No remaining issues, just things that could theoretically be in a separate PR.
- name: Cache dependencies | ||
uses: actions/cache@v4.0.0 | ||
uses: actions/cache@v4.0.2 |
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.
Most of these version bumps should be saved for another PR, probably by dependabot
|
||
#### Install dev dependencies | ||
|
||
For development you can install the required dependencies using `pip install '.[all]'. |
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.
These should really be in a separate PR too
split-on-trailing-comma = false | ||
|
||
[tool.ruff.lint.pydocstyle] | ||
convention = "google" |
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.
This isn't being used yet
Ruff appears to be an alternative to using separate black/flake8/isort/pyupgrade/pydocstyle. This PR transitions the repo to use ruff.