#129
gdtest_rst_tip
OK
CONFIG
Tests tip RST directives in docstrings
Docstrings contain '.. tip::' directives. The built-in handler should produce Quarto tip callouts. Two functions have helpful tips.
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
L5
L5.. tip::docstring
Source Files
gdtest_rst_tip/
__init__.py
"""Package testing tip RST directives."""
__version__ = "0.1.0"
__all__ = ["optimize", "batch_process"]
def optimize(data: list) -> list:
"""
Optimize the given data for processing.
Parameters
----------
data
The data to optimize.
Returns
-------
list
The optimized data.
.. tip::
Pre-sort the data for better performance.
"""
return data
def batch_process(items: list, chunk_size: int = 100) -> list:
"""
Process items in batches.
Parameters
----------
items
The items to process.
chunk_size
The number of items per batch.
Returns
-------
list
The processed results.
.. tip::
Use chunk_size=50 for memory-constrained systems.
"""
return itemsREADME.md
# gdtest-rst-tip Tests tip RST directives in docstrings.
great-docs.yml
parser: sphinx