Links
AI / Agents
gdtest-rst-caution
Tests caution RST directives in docstrings.
Docstrings contain ‘.. caution::’ directives. The built-in handler should produce Quarto caution callouts. Two functions exercise them.
Source files
gdtest_rst_caution/
__init__.py
"""Package testing caution RST directives."""
__version__ = "0.1.0"
__all__ = ["modify_schema", "migrate"]
def modify_schema(changes: dict) -> None:
"""
Apply schema modifications.
Parameters
----------
changes
A dictionary describing the schema changes.
Returns
-------
None
.. caution::
Schema changes may break existing data.
"""
pass
def migrate(version: str) -> bool:
"""
Migrate the database to the specified version.
Parameters
----------
version
The target version to migrate to.
Returns
-------
bool
True if migration was successful.
.. caution::
Always back up before migrating.
"""
return TrueREADME.md
# gdtest-rst-caution Tests caution RST directives in docstrings.
great-docs.yml
parser: sphinx