-
Notifications
You must be signed in to change notification settings - Fork 23
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
feat: replace pydocstyle
with ruff
#473
base: main
Are you sure you want to change the base?
Conversation
Thanks for the pull request, @BryanttV! This repository is currently maintained by Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review. 🔘 Get product approvalIf you haven't already, check this list to see if your contribution needs to go through the product review process.
🔘 Provide contextTo help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:
🔘 Get a green buildIf one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green. Where can I find more information?If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources: When can I expect my changes to be merged?Our goal is to get community contributions seen and reviewed as efficiently as possible. However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:
💡 As a result it may take up to several weeks or months to complete a review and merge your PR. |
Hi @mariajgrimaldi! I replaced all Pydocstyle checks with Ruff. Currently, when I run the checks, there are 112 errors related to some rules that are not ignored initially with Pydocstyle. I wonder if we need to ignore those rules in the Ruff configuration or fix the errors. I think it is better to fix the errors, but I want to know your opinion. |
Description
This PR replaces the
pydocstyle
deprecated library withruff
.It's important to note that ruff can replace other packages such as
pylint
,pycodestyle
, andisort
. This is just the initial step to fully implement a faster and modern tool.Testing instructions
You can run
make quality
in your local or see the PR checks.Deadline
None
Checklists
Check off if complete or not applicable:
Merge Checklist:
Post Merge:
finished.