Skip to content

Commit c9241f7

Browse files
committed
style(docs): de-slop JSDoc on report folding, hang threshold, silenceMs
Drop em dashes, announcement openers ("Default false:"), and anthropomorphism ("carries the actionable punchline").
1 parent 11622de commit c9241f7

3 files changed

Lines changed: 14 additions & 17 deletions

File tree

src/domain/ports/process-runner.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,9 +42,9 @@ export interface ProcessOutput {
4242
* Milliseconds between the child's last stdout/stderr emission and the
4343
* process exit (or kill). Undefined when the runner did not track it.
4444
*
45-
* Generic timing signal: callers can use it to distinguish "still emitting
46-
* output at exit" from "went silent before exit". Interpretation (what
47-
* counts as long, what action to recommend) is the caller's responsibility.
45+
* Callers use this to tell "still emitting output at exit" from "went
46+
* silent before exit". The caller decides what counts as long and what
47+
* action to recommend.
4848
*/
4949
readonly silenceMs?: number;
5050
}

src/interface/cli/format-report.ts

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -36,12 +36,10 @@ const SHOW_FIRST = 3;
3636

3737
export 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
*/
214212
function formatTeaser(first: TaggedDiagnostic | undefined): string | null {
215213
if (first === undefined) return null;

src/use-cases/validate-output/run-astro-check.ts

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -92,10 +92,9 @@ function looksLikeNotInstalled(stdout: string, stderr: string): boolean {
9292
}
9393

9494
/**
95-
* Threshold past which stdout silence before kill is interpreted as "hung",
96-
* not "slow". 30s is conservative: astro check on a 2k-page site still emits
97-
* progress more often than that, so longer gaps signal a tight loop in the
98-
* language server rather than honest forward progress.
95+
* Threshold past which we call a silent gap a hang instead of slow progress.
96+
* 30s is conservative: astro check on a 2k-page site emits progress more
97+
* often than that. Longer gaps point at a tight loop in the language server.
9998
*/
10099
const HANG_SILENCE_MS = 30_000;
101100

0 commit comments

Comments
 (0)