Remove empty lines between a function's doc string and body

[ggoodvin-fincad]

Black v21.4b2

Playground link

Options

--line-length=88
--safe

Input

def some_func():
    """Doc string."""
    
    return 1.0
    
def some_other_func():
    """Doc string."""
    return 2.0

Output

def some_func():
    """Doc string."""

    return 1.0


def some_other_func():
    """Doc string."""
    return 2.0

Expected

def some_func():
    """Doc string."""
    return 1.0


def some_other_func():
    """Doc string."""
    return 2.0

(Or insert a single empty line in both cases, no strong preference, just after consistency).

[felix-hilden]

If I had to choose, it would be removed. Multi-line docstrings in particular have a good visual distinction with the first line already:

def foo():
    """
    Docstring.

    On multiple lines explaining the function
    that needs documentation.
    """
    return 1 + 1 == 2

But I don't feel strongly about one-line docs. Looking at my own code I tend to write without the empty line, but I can imagine others might want it for separation. What do the maintainers think?

[xrisk]

Perhaps look at what some of the repos that primer checks does (or other authoritative sources)? There should be some strong precedent for enforcing one style over another I think.

[felix-hilden]

Looks like this is essentially the same as #2370, and since there's been more discussion over there I'll close this one as a duplicate.