-
Notifications
You must be signed in to change notification settings - Fork 2.5k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
style regression: too long single line docstrings have their quotes moved to a new line. #3320
Comments
Hey! I'd like to contribute to fixing this bug as part of Hacktoberfest. |
Hi! Looking at the changes again, it seems intended. @itxasos23 Thanks for offering! However, #2885 deals with docstrings and could clash with this change. So I think we'll at least have to discuss a bit. If you'd be willing to try something else, have a look at the ones in
good first issue
|
The biggest problem is this change for single line docstrings is a violation of PEP 257.
|
@felix-hilden Amazing! I see you got that covered on that PR 😄 |
This pr is in agreement with 2885, as the author of 2885 states:
This is in line with pep 257, and should satisfy this issue as well. |
I propose a fix in #3430. cc @idorrington92 as the author of #3044 which introduced this behavior. |
Describe the bug
Single-line docstrings that are longer than the line length have the final three
"
moved to a new line.To Reproduce
For example, take this code:
And run it with these arguments:
We get this format:
Expected behavior
Single line docstrings are left alone. I understand what this change is supposed to do, and on already multiline docstrings this wouldn't be an issue (although it would be nice for the docstring formatter to be entirely consistent among all docstrings instead of having different behavior for the line length but i digress).
Environment
Additional Comments
This seems like a regression from #3044
The text was updated successfully, but these errors were encountered: