griffe_warnings_deprecated ¤

griffe-warnings-deprecated package.

Griffe extension for @warnings.deprecated (PEP 702).

Modules:

Classes:

WarningsDeprecatedExtension –

Griffe extension for @warnings.deprecated (PEP 702).

WarningsDeprecatedExtension ¤

WarningsDeprecatedExtension(
    kind: str = "danger",
    title: str | None = "Deprecated",
    label: str | None = "deprecated",
)

Bases: Extension

Griffe extension for @warnings.deprecated (PEP 702).

Parameters:

kind (str, default: 'danger' ) –

Admonitions kind.
title (str | None, default: 'Deprecated' ) –

Admonitions title.
label (str | None, default: 'deprecated' ) –

Label added to deprecated objects.

Methods:

on_class_instance –

Add section to docstrings of deprecated classes.
on_function_instance –

Add section to docstrings of deprecated functions.

on_class_instance(
    node: AST | ObjectNode, cls: Class
) -> None

Add section to docstrings of deprecated classes.

on_function_instance(
    node: AST | ObjectNode, func: Function
) -> None

Add section to docstrings of deprecated functions.