Links
AI / Agents
gdtest-rst-warning
Tests warning RST directives in docstrings.
Docstrings contain ‘.. warning::’ directives. The built-in handler should produce Quarto warning callouts. Two functions have warning blocks.
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.
"""
passREADME.md
# gdtest-rst-warning Tests warning RST directives in docstrings.
great-docs.yml
parser: sphinx