Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
By using
extend-select
, we don't need to runruff
check twiceAdds info to README on how to go about fixing linting/formatting errors
Adds checks for:
UP
: upgrade syntax for newer versions of PythonD
: google-style docstrings on all public methodsANN
: use of type annotationsPTH
: preferpathlib
overos.path
which are all informal best practices on the team but not previously strictly enforced.
Notably, the additional checks will significantly increase the work required to align our code with this action. All work that I think is worth doing, but I'm def. open to pushback, or incrementally adding these checks.
To reduce the work required to migrate a code base, Ruff provides a way to add
noqa
statements to existing issues and only be strict with new issues: https://docs.astral.sh/ruff/tutorial/#adding-rulesThat might be a good path forward for especially hyp3-gamma, but I'd be inclined to try and fix everything if possible and only fall back to
noqa
if it's too hard to switch.See ASFHyP3/hyp3-isce2#156 for and example of what these additional checks would look like.