Skip to content

Doc impact text

doc_impact_text

render_doc_impact_text(result)

Render doc impact result as compact text.

Source code in packages/axm-ast/src/axm_ast/tools/doc_impact_text.py
Python
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
def render_doc_impact_text(result: dict[str, Any]) -> str:
    """Render doc impact result as compact text."""
    parts = [_header(result)]

    refs_text = _render_refs(result.get("doc_refs", {}))
    if refs_text:
        parts.append(refs_text)

    undocumented = result.get("undocumented", [])
    if undocumented:
        parts.append(f"undocumented: {', '.join(undocumented)}")

    stale_text = _render_stale(result.get("stale_signatures", []))
    if stale_text:
        parts.append(stale_text)

    return "\n\n".join(parts)