docs(CLI): the show-form guard types 51 forms / 102 commands, 60 refusals #1687

Merged
jaylouisw merged 1 commit from docs/1116-1616 into main 2026-11-16 16:19:41 +00:00
Owner

What was untrue

docs/CLI.md, section Every show form on this page is typed by a test, claimed the guard enumerates 49 forms, 98 commands and that sixty-two of the ninety-eight answers are device-level refusals.

Evidence from the code

node test/docs-show-commands.test.js on origin/main prints:

The documentation names 51 show forms, and the console answers every one:
    (102 commands typed across a router and a switch)
    (60 refusals, all about the device rather than the syntax)

Why it moved: the suite enumerates every backticked show � on the page, and #1679 (24a3f09d) added show ? and show ipv6 ? to the help-key section � 49 -> 51 forms. The paragraph was last touched by #1672, which had made it 49/98.

Fix

Docs-only: the numbers now match the suite, and the paragraph says where the last two forms come from. No guard asserts those prose counts, which is why the drift survived.

Gates

  • node scripts/syntax-check.js � 354 files, all OK
  • check-control-bytes.js � clean
  • check-doc-citations.js � 352 citations, none >40 lines from its code
  • test/docs-show-commands.test.js � 7 passed / 0 failed (51 forms, 102 commands, 60 refusals; same before and after)
  • test/help-completeness.test.js � 8 / 0 (98 advertised commands accepted, 18 mechanisms, 16 show rows)
  • test/help-key-is-not-a-value.test.js � 23 / 0
  • test/help-key-works-in-every-prompt.test.js � 10 / 0
## What was untrue `docs/CLI.md`, section *Every `show` form on this page is typed by a test*, claimed the guard enumerates **49 forms, 98 commands** and that **sixty-two of the ninety-eight** answers are device-level refusals. ## Evidence from the code `node test/docs-show-commands.test.js` on `origin/main` prints: ``` The documentation names 51 show forms, and the console answers every one: (102 commands typed across a router and a switch) (60 refusals, all about the device rather than the syntax) ``` Why it moved: the suite enumerates every backticked `show �` on the page, and #1679 (24a3f09d) added `show ?` and `show ipv6 ?` to the help-key section � 49 -> 51 forms. The paragraph was last touched by #1672, which had made it 49/98. ## Fix Docs-only: the numbers now match the suite, and the paragraph says where the last two forms come from. No guard asserts those prose counts, which is why the drift survived. ## Gates - `node scripts/syntax-check.js` � 354 files, all OK - `check-control-bytes.js` � clean - `check-doc-citations.js` � 352 citations, none >40 lines from its code - `test/docs-show-commands.test.js` � 7 passed / 0 failed (51 forms, 102 commands, 60 refusals; same before and after) - `test/help-completeness.test.js` � 8 / 0 (98 advertised commands accepted, 18 mechanisms, 16 `show` rows) - `test/help-key-is-not-a-value.test.js` � 23 / 0 - `test/help-key-works-in-every-prompt.test.js` � 10 / 0
docs(CLI): the show-form guard types 51 forms / 102 commands, 60 of them refusals
All checks were successful
CI / Classify the change (pull_request) Successful in 13s
PR rebase / Rebase onto main and arm auto-merge (pull_request) Successful in 19s
CI / Server smoke test (pull_request) Has been skipped
CI / Docker build (pull_request) Has been skipped
CI / Test (Node 18) (pull_request) Successful in 1m18s
CI / Test (Node 20) (pull_request) Successful in 1m20s
CI / Test (Node 22) (pull_request) Successful in 1m33s
3eba3c40c0
The counts paragraph was written when the file named 49 forms (98 commands, 62
refusals) - #1672's number. #1679 added the `show ?` and `show ipv6 ?` examples
to the help-key section, and test/docs-show-commands.test.js enumerates every
backticked `show …` on the page, so both became forms the suite types: 51 forms,
102 commands across the router and the switch, 60 of those answers device-level
refusals. Measured by the test itself, not estimated.
jaylouisw scheduled this pull request to auto merge when all checks succeed 2026-11-16 16:19:33 +00:00
Sign in to join this conversation.
No reviewers
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
jaylouisw/packetforge!1687
No description provided.