vertebrae.reports.markdown_report

Markdown report rendering.

Functions

save_markdown_report(result, path)	Save a benchmark result as a Markdown report.
render_markdown_report(result)	Render a benchmark result as Markdown.

Module Contents

vertebrae.reports.markdown_report.save_markdown_report(result, path)

Save a benchmark result as a Markdown report.

Parameters:

• result (Any) – Result object renderable by render_markdown_report.

• path (str) – Destination file path.

Return type:

None

vertebrae.reports.markdown_report.render_markdown_report(result)

Render a benchmark result as Markdown.

Parameters:

result (Any) – Benchmark result object.

Returns:

Markdown report text.

Return type:

str