class-attribute-missing-description (PDF712)¶

Part of the PDF rule category.

View source · View documentation source · Search issues

Fix is not available.

Rule is disabled if docstring-convention is none or pep257.

What it does¶

Checks that parsed class attribute entries in owning class docstrings include a prose description.

Only entries that match inventoried class or instance attributes are checked. Attached attribute docstrings are intentionally not checked by PDF7xx rules.

Why is this useful?¶

Attribute entries without descriptions do not explain class state or constants.

Ruff compatibility¶

None.

Examples¶

PDF712 reports class attribute entries without descriptions:

docstring-convention = "google"

class Client:
    """Client.

    Attributes:
        timeout (int):
        retries:
    """

    timeout: int = 1
    retries: int = 3

PDF712: Line 5: Class attribute 'timeout' docstring entry is missing a description
PDF712: Line 6: Class attribute 'retries' docstring entry is missing a description

Class attribute entries with descriptions are accepted:

docstring-convention = "google"

class Client:
    """Client.

    Attributes:
        timeout (int): Timeout in seconds.
    """

    timeout: int = 1

Attached attribute docstrings are ignored by PDF7xx owning-docstring rules:

docstring-convention = "google"

class Client:
    timeout: int = 1
    """Timeout.

    Attributes:
        timeout (str):
    """

Options¶

None.