Skip to content
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

Removed adding a space into empty docstrings. #2249

Merged
merged 3 commits into from May 25, 2021
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGES.md
Expand Up @@ -4,6 +4,7 @@

### _Black_

- A space is no longer inserted into empty docstrings (#2249)
- Respect `.gitignore` files in all levels, not only `root/.gitignore` file (apply
`.gitignore` rules like `git` does) (#2225)
- Restored compatibility with Click 8.0 on Python 3.6 when LANG=C used (#2227)
Expand Down
4 changes: 2 additions & 2 deletions src/black/linegen.py
Expand Up @@ -236,6 +236,7 @@ def visit_STRING(self, leaf: Leaf) -> Iterator[Line]:
# characters but only if they are the same as the first.
quote_len = 1 if docstring[1] != quote_char else 3
docstring = docstring[quote_len:-quote_len]
docstring_started_empty = not docstring

if is_multiline_string(leaf):
indent = " " * 4 * self.current_line.depth
Expand All @@ -255,8 +256,7 @@ def visit_STRING(self, leaf: Leaf) -> Iterator[Line]:
# Odd number of tailing backslashes, add some padding to
# avoid escaping the closing string quote.
docstring += " "
else:
# Add some padding if the docstring is empty.
elif not docstring_started_empty:
docstring = " "

# We could enforce triple quotes at this point.
Expand Down
16 changes: 8 additions & 8 deletions tests/data/docstring.py
Expand Up @@ -102,7 +102,7 @@ def and_this():
"hey yah"'''


def empty():
def multiline_whitespace():
'''


Expand All @@ -111,11 +111,11 @@ def empty():
'''


def oneline_empty():
def oneline_whitespace():
''' '''


def oneline_nothing():
def empty():
""""""


Expand Down Expand Up @@ -293,16 +293,16 @@ def and_this():
"hey yah"'''


def empty():
def multiline_whitespace():
""" """


def oneline_empty():
def oneline_whitespace():
""" """


def oneline_nothing():
""" """
def empty():
""""""


def single_quotes():
Expand Down Expand Up @@ -374,4 +374,4 @@ def my_god_its_full_of_stars_1():

# the space below is actually a \u2001, removed in output
def my_god_its_full_of_stars_2():
"I'm sorry Dave"
"I'm sorry Dave"