ruff: Enable pydocstyle w/ numpy convention #449
Merged
Conversation
This file contains hidden or 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
tony
force-pushed
the
pydocstyle
branch
4 times, most recently
from
bcbb91d to
28059d0
Compare
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #449 +/- ##
==========================================
- Coverage 62.61% 62.59% -0.03%
==========================================
Files 39 39
Lines 3440 3438 -2
Branches 927 927
==========================================
- Hits 2154 2152 -2
Misses 770 770
Partials 516 516 ☔ View full report in Codecov by Sentry. |
`ruff --show-fixes --fix-only .`
Fixed 50 errors:
- src/libvcs/_internal/dataclasses.py:
2 × D412 (blank-lines-between-header-and-content)
- src/libvcs/_internal/subprocess.py:
1 × D412 (blank-lines-between-header-and-content)
- src/libvcs/_internal/types.py:
1 × D412 (blank-lines-between-header-and-content)
- src/libvcs/cmd/git.py:
13 × D403 (first-line-capitalized)
1 × D202 (no-blank-line-after-function)
- src/libvcs/cmd/hg.py:
1 × D202 (no-blank-line-after-function)
- src/libvcs/cmd/svn.py:
1 × D202 (no-blank-line-after-function)
- src/libvcs/sync/base.py:
1 × D202 (no-blank-line-after-function)
- src/libvcs/sync/git.py:
2 × D202 (no-blank-line-after-function)
1 × D412 (blank-lines-between-header-and-content)
- src/libvcs/sync/svn.py:
1 × D202 (no-blank-line-after-function)
- src/libvcs/url/git.py:
7 × D412 (blank-lines-between-header-and-content)
1 × D405 (capitalize-section-name)
- src/libvcs/url/hg.py:
7 × D412 (blank-lines-between-header-and-content)
1 × D405 (capitalize-section-name)
- src/libvcs/url/svn.py:
7 × D412 (blank-lines-between-header-and-content)
1 × D405 (capitalize-section-name)
- tests/sync/test_git.py:
1 × D403 (first-line-capitalized)
Fixed 50 errors (39 additional fixes available with `--unsafe-fixes`).
`ruff --show-fixes --fix-only --unsafe-fixes .`
Fixed 39 errors:
- conftest.py:
1 × D400 (ends-in-period)
- docs/conf.py:
1 × D400 (ends-in-period)
- src/libvcs/_internal/query_list.py:
1 × D400 (ends-in-period)
- src/libvcs/_internal/subprocess.py:
1 × D301 (escape-sequence-in-docstring)
- src/libvcs/_internal/types.py:
1 × D400 (ends-in-period)
- src/libvcs/cmd/git.py:
13 × D400 (ends-in-period)
- src/libvcs/cmd/hg.py:
2 × D400 (ends-in-period)
- src/libvcs/cmd/svn.py:
1 × D400 (ends-in-period)
- src/libvcs/pytest_plugin.py:
3 × D400 (ends-in-period)
- src/libvcs/sync/git.py:
3 × D400 (ends-in-period)
- src/libvcs/sync/svn.py:
1 × D400 (ends-in-period)
- src/libvcs/url/base.py:
2 × D400 (ends-in-period)
- src/libvcs/url/registry.py:
1 × D400 (ends-in-period)
- tests/_internal/subprocess/test_SubprocessCommand.py:
5 × D400 (ends-in-period)
- tests/url/test_git.py:
1 × D400 (ends-in-period)
- tests/url/test_hg.py:
1 × D400 (ends-in-period)
- tests/url/test_svn.py:
1 × D400 (ends-in-period)
Fixed 39 errors.
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.
Appendix