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

compare_docstring_content

def compare_docstring_content(file_content: str, docstring: str, abci_app_name: str) -> Tuple[bool, str]

Update docstrings.