Links
AI / Agents
gdtest-rst-danger
Tests danger RST directives in docstrings.
Docstrings contain ‘.. danger::’ directives. The built-in handler should produce Quarto important callouts. Two functions have hazard warnings.
Source files
gdtest_rst_danger/
__init__.py
"""Package testing danger RST directives."""
__version__ = "0.1.0"
__all__ = ["drop_database", "purge_cache"]
def drop_database(name: str) -> None:
"""
Drop an entire database by name.
Parameters
----------
name
The name of the database to drop.
Returns
-------
None
.. danger::
This permanently destroys the database.
"""
pass
def purge_cache() -> int:
"""
Purge all entries from the cache.
Returns
-------
int
The number of cache entries purged.
.. danger::
Cannot be reversed. All cached data is lost.
"""
return 0README.md
# gdtest-rst-danger Tests danger RST directives in docstrings.
great-docs.yml
parser: sphinx