Skip to main content

multi_to_markdown

Function multi_to_markdown 

Source
pub fn multi_to_markdown(multi: &MultiReport) -> String
Available on crate feature markdown only.
Expand description

Render a MultiReport to a CommonMark-compatible Markdown string.

Renders a top-level summary followed by each constituent report as an ## H2 section.

ยงExample

use dev_report::{markdown, CheckResult, MultiReport, Report};

let mut bench = Report::new("c", "0.1.0").with_producer("dev-bench");
bench.push(CheckResult::pass("hot"));
let mut multi = MultiReport::new("c", "0.1.0");
multi.push(bench);

let md = markdown::multi_to_markdown(&multi);
assert!(md.starts_with("# MultiReport"));