Support docformatter 1.6.0+ #18790
Merged
Support docformatter 1.6.0+ #18790
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
|
Fixes #18706 |
kaos
approved these changes
Apr 22, 2023
| # (All versions return 3 in check mode if any files would have changed, but that is | ||
| # not an issue here). | ||
| if result.exit_code not in [0, 3]: | ||
| # TODO(#12725):It would be more straightforward to force the exception with: |
There was a problem hiding this comment.
I don't get the reference to #12725
There was a problem hiding this comment.
Ah, I cargo-culted that from other files that mentioned the inability to convert FallibleProcessResult to ProcessResult.
Yeah, I'm not 100% sure why that is the referenced PR.
There was a problem hiding this comment.
also, I would expect the TODO to reference an open issue.. ;)
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.
Docformatter 1.6.0 introduced a "feature" that is actually a nuisance:
it returns exit code 3 when modifying files in-place.
We don't actually upgrade the default version in this PR, because the new
version of docformatter has logic changes that wreak havoc on our docstrings.
But I have tested this change on both old and new versions of Docformatter.