@@ -36,12 +36,10 @@ const SHOW_FIRST = 3;
3636
3737export interface FormatReportOptions {
3838 /**
39- * Expand info-severity groups (show example rows + collapse summary like
40- * warnings and errors). Default false: info groups render as header-only
41- * because info is background context, not a punch list, and showing every
42- * row inflates the report on info-heavy sites without changing what the
43- * user has to do. Errors and warnings ignore this flag — both are always
44- * fully rendered.
39+ * Expand info-severity groups so they render rows + collapse summary like
40+ * warnings and errors. Defaults to false. Info diagnostics are background
41+ * context; rendering every row inflates the report without surfacing new
42+ * actions. Errors and warnings ignore this flag and always render rows.
4543 */
4644 readonly verbose ?: boolean ;
4745}
@@ -206,10 +204,10 @@ function formatGroupHeader(ruleId: string, items: ReadonlyArray<TaggedDiagnostic
206204}
207205
208206/**
209- * One -line teaser for a folded info group: first sentence of the first
210- * message, dim and indented. Carries the actionable punchline ("Install
211- * starlight-openapi") without re-expanding every row . Returns null if the
212- * group is empty.
207+ * Build a one -line teaser for a folded info group: the first sentence of
208+ * the group's first message, dim and indented. The user still sees the
209+ * action signal ("Install starlight-openapi") without --verbose . Returns
210+ * null if the group is empty.
213211 */
214212function formatTeaser ( first : TaggedDiagnostic | undefined ) : string | null {
215213 if ( first === undefined ) return null ;
0 commit comments