Copies and docstring styling #15202
Merged
Copies and docstring styling #15202
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
sgugger
commented
Jan 18, 2022
|
|
||
|
|
||
| def style_file_docstrings(code_file, max_len=119, check_only=False): | ||
| def style_docstrings_in_code(code, max_len=119): |
There was a problem hiding this comment.
Splitting this function in two so I have one I can use to format code in check_copies.
sgugger
commented
Jan 18, 2022
| if has_indent: | ||
| code = f"class Bla:\n{code}" | ||
| result = black.format_str(code, mode=black.FileMode([black.TargetVersion.PY35], line_length=119)) | ||
| result, _ = style_docstrings_in_code(result) |
There was a problem hiding this comment.
This is the main change.
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.
What does this PR do?
This PR makes the
check_copiesscript a little bit more resilient by making sure it applies the styling on the docstrings when making/checking the copies. This will fixe issues like the one encountered in #15079