Skip to content

Commit fa078d0

Browse files
committed
docs: adjust docs
1 parent 2829b4d commit fa078d0

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

packages/cli/docs/scoring.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -297,15 +297,16 @@ xychart-beta
297297

298298
---
299299

300-
### Issue Penalty Scoring
300+
### Issue Penalty Scoring Details
301301

302-
Combines threshold limits with diagnostic penalties for comprehensive scoring.
302+
Combines threshold limits with diagnostic penalties for comprehensive scoring. **Builds on [Linear Overshoot](#linear-overshoot-details)** by adding penalty deductions based on diagnostic issues.
303303

304304
**Pros:**
305305

306306
- Combines quantitative limits with quality metrics
307307
- Configurable penalty weights for different issue types
308308
- Applicable to any metric with both thresholds and diagnostics
309+
- Familiar [Linear Overshoot](#linear-overshoot-details) behavior for size component
309310

310311
**Cons:**
311312

@@ -325,7 +326,7 @@ function issuePenaltyScore(value: number, threshold: number, errors: number, war
325326
```
326327

327328
**When to use it:**
328-
Ideal for production metrics where you need to balance performance targets with maintainability diagnostics.
329+
Ideal for production metrics where you need to balance performance targets with maintainability diagnostics. Natural extension if you're already using [Linear Overshoot](#linear-overshoot-details) and want to add quality penalties.
329330

330331
**Examples:**
331332
Bundle size + ESLint errors, page load time + accessibility warnings, complexity thresholds + TypeScript diagnostics.
@@ -351,6 +352,8 @@ $`
351352
\end{cases}
352353
`$
353354

355+
_Note: This is [Linear Overshoot](#linear-overshoot-details) with a floor at 0_
356+
354357
##### Issues penalty
355358

356359
$`
@@ -369,7 +372,7 @@ $`
369372

370373
```mermaid
371374
xychart-beta
372-
title "Score vs Value (with penalty shift)"
375+
title "Issue Penalty Scoring (penalty shift optional)"
373376
x-axis [0, 1, 1.25, 1.5, 1.75, 2]
374377
y-axis "Score" 0 --> 1
375378
line Original [1, 1, 0.75, 0.5, 0.25, 0]

0 commit comments

Comments
 (0)