Skip to content

Commit ab852a2

Browse files
committed
docs(skills): name both ESLint directives the comment audit rejects
1 parent b4577a9 commit ab852a2

1 file changed

Lines changed: 1 addition & 1 deletion

File tree

  • .agents/skills/you-might-not-need-a-comment

‎.agents/skills/you-might-not-need-a-comment/SKILL.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ This codebase's convention: **TSDoc for documentation; an inline `//` only for a
3333
- A `//` comment that explains a **non-obvious why**: a workaround for an upstream bug, an ordering constraint, a perf reason, a spec/edge-case the code can't self-document (`// first-match wins — matches the old find() semantics`).
3434
- Existing TSDoc `/** ... */` blocks on declarations — leave them (only tighten if verbose).
3535
- `// boundary-raw-fetch:`, `// double-cast-allowed:`, `// boundary-raw-json:`, `// untyped-response:`, `-- migration-safe:` (SQL migrations), `// rq-lint-allow:`, `// client-boundary-allow:` and any other `<kebab-tag>: <reason>` annotation a script under `scripts/` greps for, in line-comment or block-comment form (e.g. the `/** svg-path-precision-exception: ... */` directive on icon paths) — these are load-bearing, never touch them.
36-
- `// biome-ignore`, `// @ts-expect-error` and other tooling directives. (Nothing runs ESLint, so `eslint-disable` is dead and `check:comment-hygiene` rejects it.)
36+
- `// biome-ignore`, `// @ts-expect-error` and other tooling directives. (Nothing runs ESLint, so `eslint-disable`/`eslint-enable` directives are dead; delete them — `check:comment-hygiene` rejects both.)
3737
- `// TODO` / `// FIXME` that point at real, still-open work.
3838

3939
## Bias

0 commit comments

Comments
 (0)