docs: the show-form count on CLI.md is 48 forms / 96 commands, not 47 / 94 #1628

Merged
jaylouisw merged 1 commit from docs/1116-0746 into main 2026-11-16 07:52:00 +00:00
Owner

docs/CLI.md says test/docs-show-commands.test.js types "47 forms, 94 commands today" and that "Fifty-eight of the ninety-four answers" are legitimate refusals.

The suite derives the forms from that same page and types every one at a router and a switch. Running it on this branch prints:

The documentation names 48 show forms, and the console answers every one:
    (96 commands typed across a router and a switch)
    (60 refusals, all about the device rather than the syntax)
7 passed, 0 failed

So the sentence was stale by one form (two answers) and two refusals � no documented form is refused as a spelling the parser does not know, and every refusal still carries a reason. Only the three figures changed; the surrounding claim and the show spanning-trees example were re-verified at a router and a switch and still reproduce byte for byte.

Guards on this branch: syntax-check 342 files OK; docs-show-commands 7 passed / 0 failed (48 forms, 96 commands, 60 refusals); help-completeness 8 passed / 0 failed; help-key-works-in-every-prompt 9 passed; doc-catalog-counts 24 passed; check-control-bytes clean.

Follow-up worth considering (not in this docs-only PR): the figures rot whenever a row is added � a one-line assertion in the suite against this sentence would keep them honest.

`docs/CLI.md` says `test/docs-show-commands.test.js` types "47 forms, 94 commands today" and that "Fifty-eight of the ninety-four answers" are legitimate refusals. The suite derives the forms from that same page and types every one at a router and a switch. Running it on this branch prints: ``` The documentation names 48 show forms, and the console answers every one: (96 commands typed across a router and a switch) (60 refusals, all about the device rather than the syntax) 7 passed, 0 failed ``` So the sentence was stale by one form (two answers) and two refusals � no documented form is refused as a spelling the parser does not know, and every refusal still carries a reason. Only the three figures changed; the surrounding claim and the `show spanning-trees` example were re-verified at a router and a switch and still reproduce byte for byte. Guards on this branch: syntax-check 342 files OK; docs-show-commands 7 passed / 0 failed (48 forms, 96 commands, 60 refusals); help-completeness 8 passed / 0 failed; help-key-works-in-every-prompt 9 passed; doc-catalog-counts 24 passed; check-control-bytes clean. Follow-up worth considering (not in this docs-only PR): the figures rot whenever a row is added � a one-line assertion in the suite against this sentence would keep them honest.
docs: the show-form count on CLI.md is what the suite prints — 48 forms, 96 commands, 60 refusals
All checks were successful
CI / Classify the change (pull_request) Successful in 12s
PR rebase / Rebase onto main and arm auto-merge (pull_request) Successful in 18s
CI / Server smoke test (pull_request) Has been skipped
CI / Docker build (pull_request) Has been skipped
CI / Test (Node 20) (pull_request) Successful in 1m16s
CI / Test (Node 18) (pull_request) Successful in 1m29s
CI / Test (Node 22) (pull_request) Successful in 1m34s
bbff76940d
The paragraph promised 47 forms and 94 commands and 58 refusals. test/docs-show-commands.test.js
derives the forms from docs/CLI.md and types each at a router and a switch; today it prints
'48 show forms', '(96 commands typed)' and '(60 refusals)'. The numbers were stale by two forms,
not by a mistake in the test: every row still answers.

No prose changed beyond the three figures.
jaylouisw scheduled this pull request to auto merge when all checks succeed 2026-11-16 07:51:52 +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!1628
No description provided.