NarrativeReport
data class NarrativeReport(val findings: List<Finding> = emptyList(), val readingOrder: List<ReadingStep> = emptyList(), val summary: String = "")(source)
The full set of findings for one project, in reading order.
Parameters
findings
Every finding produced, ordered most-important-first within each category.
readingOrder
The modules to understand first, in the order to read them, with a sentence each. Empty for a project too small for the order to mean anything.
summary
A short paragraph describing the project as a whole - the first thing a reader who has never seen the codebase should read.
Constructors
Link copied to clipboard
constructor(findings: List<Finding> = emptyList(), readingOrder: List<ReadingStep> = emptyList(), summary: String = "")