#126
gdtest_rst_deprecated
OK
CONFIG
Tests deprecated RST directives in docstrings
Docstrings contain '.. deprecated:: 1.5' with deprecation message. The built-in handler should produce Quarto warning callouts. Two functions have deprecated directives.
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
L2
L2.. deprecated::docstring
Source Files
gdtest_rst_deprecated/
__init__.py
"""Package testing deprecated RST directives."""
__version__ = "0.1.0"
__all__ = ["old_connect", "legacy_parse"]
def old_connect(host: str) -> bool:
"""
Connect to a host using the legacy protocol.
Parameters
----------
host
The hostname to connect to.
Returns
-------
bool
True if connection was successful.
.. deprecated:: 1.5
Use connect_v2() instead.
"""
return True
def legacy_parse(text: str) -> dict:
"""
Parse text using the legacy parser.
Parameters
----------
text
The text to parse.
Returns
-------
dict
The parsed result.
.. deprecated:: 2.0
Use parse_modern() instead.
"""
return {}README.md
# gdtest-rst-deprecated Tests deprecated RST directives in docstrings.
great-docs.yml
parser: sphinx