missing-public-class-documentation (PDF604)¶

Part of the PDF rule category.

View source · View documentation source · Search issues

Fix is not available.

What it does¶

Checks for public top-level classes that are missing docstrings.

Nested classes are handled by the nested-class rules, and local classes inside functions are ignored. A top-level class is public when its own name and containing module path are public.

Why is this useful?¶

Public classes should describe their purpose and behavior.

Ruff compatibility¶

This rule replaces Ruff's D101.

Examples¶

A public top-level class without a docstring is reported:

class Client:
    pass

PDF604: Line 1: Public class 'Client' is missing docstring

A documented public top-level class is accepted:

class Client:
    """Client API."""

Nested classes are handled by PDF606 and PDF607 instead:

class Client:
    """Client API."""

    class Response:
        pass

Private class names and private module paths are handled by PDF605 instead:

class Client:
    pass

class _PrivateClient:
    pass

Options¶

None.