Enable pydocstyle linting #206
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
Remove default_language_version as this is causing more problems than it solves.
Docstrings edited to follow consistent rules. Add missing docstrings to some modules and functions. Fix the poor wording on some recent docstrings.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #206 +/- ##
==========================================
- Coverage 96.81% 96.80% -0.01%
==========================================
Files 15 15
Lines 1288 1285 -3
==========================================
- Hits 1247 1244 -3
Misses 41 41 ☔ View full report in Codecov by Sentry. |
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.
Updated
.pre-commit-config.yamland removeddefault_language_versionfor now as it was overly strict and causing minor issues.Enabled the
pydocstylerule for Ruff and updated thepyproject.tomlfile to a less deprecated layout.Applied the new rule to all relevant files. Includes adding docstrings to some functions and modules which were missing any.
These changes are not meant to affect any code, although a test involving patched wheels was updated to be aware of a modules new docstring.