← GDG /

#128 gdtest_rst_warning

#128 gdtest_rst_warning OK CONFIG
Tests warning RST directives in docstrings
Docstrings contain '.. warning::' directives. The built-in handler should produce Quarto warning callouts. Two functions have warning blocks.
View Site → Build Log ๐Ÿงช Test Coverage

Build Mode

● Has great-docs.yml

This package ships a pre-supplied config. The great-docs init step is skipped and great-docs build uses the spec-defined configuration directly. Tests specific config options and their rendered output.

Dimensions

L4
L4.. warning::docstring

Source Files

๐Ÿ“ gdtest_rst_warning/
๐Ÿ“„ __init__.py
"""Package testing warning RST directives."""

__version__ = "0.1.0"
__all__ = ["delete_all", "force_restart"]


def delete_all(confirm: bool = False) -> int:
    """
    Delete all records from the store.

    Parameters
    ----------
    confirm
        Must be True to proceed with deletion.

    Returns
    -------
    int
        The number of records deleted.

    .. warning::
        This operation cannot be undone.
    """
    return 0


def force_restart() -> None:
    """
    Force an immediate restart of the service.

    Returns
    -------
    None

    .. warning::
        All unsaved data will be lost.
    """
    pass
๐Ÿ“„ README.md
# gdtest-rst-warning

Tests warning RST directives in docstrings.
๐Ÿ“„ great-docs.yml
parser: sphinx