Skip to content

check-shell-escape-residue.test.ts's docblock has an empty ## Fixture discipline section — its body sits two sections below, under the wrong heading #8012

Description

@baozhoutao

Filed out-of-scope from #7413 (PR #8010). Unassigned. A one-paragraph docs defect in a test docblock; filed plainly rather than folded into that PR.

What

scripts/__tests__/check-shell-escape-residue.test.ts's header docblock, on origin/main at e1545cf:

 * ## Fixture discipline
 *
 * ## The second skills root (objectui#7403)
 *
 * `SCAN_ROOTS` carries TWO skills trees: the published `skills/` and the
 * contributor tree `.claude/skills/`, ...

## Fixture discipline has no body at all. The paragraph that belongs under it is the last one in the docblock, sitting after the objectui#7403 section with no heading of its own:

 * `scripts/` is not in `SCAN_ROOTS`, so this file could carry the literal
 * plainly. It builds it from code points anyway — belt and braces against a
 * future widening of the scan surface turning this suite into the gate's own
 * first finding — and then PINS the constructed value against the shipped
 * `RESIDUE_PATTERNS` entry, so a typo in the source literal reddens here.

That is fixture discipline, and it reads as a trailing note on the skills-root section instead.

Why it happened, and why it is worth a line

The ## The second skills root (objectui#7403) section was inserted between a heading and its own body when #7403 widened the gate. The result is not merely cosmetic: an empty heading reads as a section someone meant to write and never did, so the next author is invited either to delete it (losing the pointer) or to write a second fixture-discipline paragraph under it while the original sits below (two answers to one fact). PR #8010 hit exactly that fork — its new ## Coverage section was first placed at the same insertion point, deepening the split, and was moved to the end of the docblock instead, leaving the pre-existing arrangement untouched rather than fixing it in an unrelated PR.

Fix

Move the scripts/ is not in SCAN_ROOTS paragraph back under ## Fixture discipline, above ## The second skills root. No behaviour change; the docblock is not asserted by any pin.

Not a duplicate of #6280 (stale coverage claims in a docblock — a falsified premise, not a displaced section).

Observed by the dev seat on #7413 while editing this docblock, unclaimed.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions