Skip to content

autonomy.analyse.abci.docstrings

Analyse ABCI app definitions for docstrings.

docstring_abci_app

def docstring_abci_app(abci_app: Any) -> str

Generate a docstring for an ABCI app

This ensures that documentation aligns with the actual implementation

Arguments:

  • abci_app: abci app object.

Returns:

docstring

update_docstrings

def update_docstrings(module_path: Path, docstring: str, abci_app_name: str, check: bool = False) -> bool

Update docstrings.

process_module

def process_module(module_path: Path, check: bool = False) -> bool

Process module.

Back to top