-
Notifications
You must be signed in to change notification settings - Fork 13
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
DM-39781: Clean docs and add ruff configuration #856
Merged
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
These files have lots of issues in docstrings and it's is better to global ignore many of the problems.
ktlim
reviewed
Jun 23, 2023
ktlim
reviewed
Jun 23, 2023
This runs clean with "ruff ." on tests and python directory.
Ignore the D401 error instead.
Codecov ReportPatch coverage:
Additional details and impacted files@@ Coverage Diff @@
## main #856 +/- ##
==========================================
- Coverage 88.01% 88.01% -0.01%
==========================================
Files 269 269
Lines 35423 35420 -3
Branches 7424 7424
==========================================
- Hits 31179 31176 -3
Misses 3103 3103
Partials 1141 1141
☔ View full report in Codecov by Sentry. |
andy-slac
approved these changes
Jun 24, 2023
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.
Looks good.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This ruff configuration matches the flake8 and pydocstyle configurations already in place but fixes all the docstrings to enable ruff to run on the entire repository.
Checklist
doc/changes