Fix multiline docstring quote normalization #1637
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
The quotes of multiline docstrings are now only normalized when string normalization is off, instead of the string normalization setting being ignored and the quotes being *always* normalized. I had to make a new test case and data file since the current pair for docstrings only worked when there is no formatting difference between the formatting results with string normalization on and off. I needed to add tests for when there *are* differences between the two. So I split test_docstring's test code when string normalization is disabled into a new test case along with a new data file.
ichard26
commented
Aug 26, 2020
Comment on lines
+521
to
+529
| @patch("black.dump_to_file", dump_to_stderr) | ||
| def test_docstring_no_string_normalization(self) -> None: | ||
| """Like test_docstring but with string normalization off.""" | ||
| source, expected = read_data("docstring_no_string_normalization") | ||
| mode = replace(DEFAULT_MODE, string_normalization=False) | ||
| not_normalized = fs(source, mode=mode) | ||
| self.assertFormatEqual(expected, not_normalized) | ||
| black.assert_equivalent(source, not_normalized) | ||
| black.assert_stable(source, not_normalized, mode=mode) | ||
| actual = fs(source, mode=mode) | ||
| self.assertFormatEqual(expected, actual) | ||
| black.assert_equivalent(source, actual) | ||
| black.assert_stable(source, actual, mode) |
There was a problem hiding this comment.
This is a terrible diff that Git produced... 🙁
|
Thanks! ✨ 🍰 ✨ |
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.
Fix #1634.
The quotes of multiline docstrings are now only normalized when string
normalization is off, instead of the string normalization setting being
ignored and the quotes being always normalized.
I had to make a new test case and data file since the current pair for
docstrings only worked when there is no formatting difference between the
formatting results with string normalization on and off. I needed to add
tests for when there are differences between the two. So I split
test_docstring's test code when string normalization is disabled into a
new test case along with a new data file.