topmark.presentation.markdown.probe

topmark / presentation / markdown / probe

Markdown presentation for the topmark probe command.

This module renders resolution probe diagnostics as document-oriented Markdown. Markdown probe output intentionally ignores TEXT-only verbosity and quiet controls and always includes selected resolution details and candidate tables when available.

render_probe_output_markdown

render_probe_output_markdown(report)

Render human-facing Markdown output for the probe command.

Parameters:

Name	Type	Description	Default
report	ProbeCommandHumanReport	Prepared human report for the probe command.	required

Returns:

Type	Description
str	Rendered Markdown output for the prepared probe report.

Source code in src/topmark/presentation/markdown/probe.py

def render_probe_output_markdown(
    report: ProbeCommandHumanReport,
) -> str:
    """Render human-facing Markdown output for the probe command.

    Args:
        report: Prepared human report for the probe command.

    Returns:
        Rendered Markdown output for the prepared probe report.
    """
    parts: list[str] = []

    parts.append(
        _render_probe_banner_markdown(
            n_files=report.file_list_total,
        )
    )
    parts.append("")
    parts.append(
        _render_probe_results_markdown(
            view_results=report.view_results,
        )
    )

    return "\n".join(parts)