Use pydocstyle instead of test #3490
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
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #3490 +/- ##
==========================================
+ Coverage 75.41% 75.53% +0.11%
==========================================
Files 113 113
Lines 13266 13252 -14
==========================================
+ Hits 10005 10010 +5
+ Misses 3261 3242 -19
|
17 tasks
flying-sheep
commented
Feb 27, 2025
Comment on lines
+252
to
271
| def _doc_params(**replacements: str): | ||
| def dec(obj: _ForT) -> _ForT: | ||
| assert obj.__doc__ | ||
| assert "\t" not in obj.__doc__ | ||
|
|
||
| # The first line of the docstring is unindented, | ||
| # so find indent size starting after it. | ||
| start_line_2 = obj.__doc__.find("\n") + 1 | ||
| assert start_line_2 > 0, f"{obj.__name__} has single-line docstring." | ||
| n_spaces = min( | ||
| len(m.group(1)) | ||
| for m in _leading_whitespace_re.finditer(obj.__doc__[start_line_2:]) | ||
| ) | ||
|
|
||
| # The placeholder is already indented, so only indent subsequent lines | ||
| indented_replacements = { | ||
| k: indent(v, " " * n_spaces)[n_spaces:] for k, v in replacements.items() | ||
| } | ||
| obj.__doc__ = obj.__doc__.format_map(indented_replacements) | ||
| return obj |
There was a problem hiding this comment.
this is probably the only interesting part of this PR
meeseeksmachine
pushed a commit
to meeseeksmachine/scanpy
that referenced
this pull request
Feb 27, 2025
flying-sheep
added a commit
that referenced
this pull request
Feb 27, 2025
Co-authored-by: Philipp A <flying-sheep@web.de>
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.
Wow this is a huge one.
This is necessary for #3485, as Python 3.13 dedents docstrings and breaks that test.
Ruff does a better job than us at testing that.
Findings for people wanting to do the same:
Do this first, else some auto“fixes” break things
Don’t rely on unsafe fixes for D301, as it doesn’t replace
\\with\when replacing"""withr"""