Request: Remove sequential blank lines in docstrings

[stinodego]

I'd like a way to get rid of extraneous whitespace in docstrings.

Here's an example of a docstring with way too much whitespace:

def cool_function(x: int) -> None:
    """
    Do nothing.

    Parameters
    ----------
    x
        Description of x.



    Notes
    -----
    Hello.


    There.


    """

I'd like ruff to format this down to:

def cool_function(x: int) -> None:
    """
    Do nothing.

    Parameters
    ----------
    x
        Description of x.

    Notes
    -----
    Hello.

    There.

    """

On a related note, there is currently no way to make sure there is no blank line after the last section (the opposite of D413). This would be a useful lint to have!

[charliermarsh]

This looks useful.

[MichaReiser]

@stinodego would you expect this to happen as part of a lint rule or are you asking for docstring formatting?

[stinodego]

I honestly don't really know what the difference is between the two. Either is fine with me!

[BrentWilkins]

This looks related to a change in this PR. Ruff is calling this docstring bad:

"""Make a summary line.

Note:
----
  Per the code comment the next two lines are blank. "// The first blank line is the line containing the closing
      triple quotes, so we need at least two."

"""

Missing blank line after last section ("Note") Ruff(D413)

I can't see what's different between what I have and the Use instead: section of the documentation.

I can make Ruff happy by adding excessive blank lines:

"""Make a summary line.

Note:
----
  Per the code comment the next two lines are blank. "// The first blank line is the line containing the closing
      triple quotes, so we need at least two."


"""

[charliermarsh]

Seems like a bug in D413 (which was incorrectly implemented before that PR, and never really triggered), but I don't think it's related to this issue per se?

[BrentWilkins]

Only in as much as this issue is to remove excessive whitespace like that bug is enforcing. I'll create a new issue for that. Thanks.