% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/explain.R
\name{explain_findings}
\alias{explain_findings}
\title{Explain findings}
\usage{
explain_findings(findings, format = "text")
}
\arguments{
\item{findings}{A list of finding lists, usually from a \code{shieldr_report}.}

\item{format}{One of \code{"text"}, \code{"markdown"}, or \code{"html"}.}
}
\value{
A character vector of formatted finding explanations.
}
\description{
Formats scanner findings for console, Markdown, or HTML presentation.
}
\details{
\code{explain_findings()} is a presentation helper. It does not rescore or
reclassify findings; it formats the finding metadata already present in a
\code{\link[=shieldr_report]{shieldr_report()}}. Console output uses severity-colored bullets. Markdown
and HTML outputs return character vectors suitable for reports, notebooks,
or lightweight dashboards.
}
\examples{
report <- scan_prompt("email me at neel@example.com", policy("enterprise_default"))
explain_findings(report$findings)
}
