no-blank-line-after-class-docstring (PDF210)¶

Part of the PDF rule category.

View source · View documentation source · Search issues

Fix is always available.

Rule is ignored by broad selectors for all docstring-convention values.

Rule is incompatible with PDF211.

What it does¶

PDF210 removes blank lines immediately after class docstrings when another statement follows in the same class body.

Only the adjacent blank-line run after the docstring statement is changed. Comments and following statements are preserved. The rule applies only to primary class docstrings. It does not apply to function docstrings, attribute docstrings, simple-suite class docstrings, or class bodies where the docstring is not followed by another body statement.

Why is this useful?¶

Some projects prefer keeping class docstrings directly attached to the following class body.

Ruff compatibility¶

This is the style-opposite companion to PDF211, which replaces Ruff's D204.

Examples¶

The canonical fix removes blank lines after a class docstring:

class Client:
    """Docstring."""

    value = 1

class Client:
    """Docstring."""
    value = 1

Comments are preserved. Multiline docstrings are targeted by their opening line, but the edit is made after the closing quote line:

class Client:
    """Summary.

    Body.
    """

    value = 1

class Other:
    """Docstring."""

    # Body comment.
    value = 1

class Client:
    """Summary.

    Body.
    """
    value = 1

class Other:
    """Docstring."""
    # Body comment.
    value = 1

Docstrings without a following body statement are ignored, even if a trailing body comment follows:

class Client:
    """Docstring."""

    # Body comment.

Options¶

None.