docs(CLI): the show-form guard counts 47 forms, not the 48 it had before #1597 #1615

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

What was untrue

docs/CLI.md, section Every show form on this page is typed by a test, claimed:

types each form at a router and a switch — 48 forms, 96 commands today …
Sixty of the ninety-six answers are refusals of that kind today

Evidence

Running the guard the paragraph describes prints the real numbers:

$ node test/docs-show-commands.test.js
The documentation names 47 show forms, and the console answers every one:
    (94 commands typed across a router and a switch)
    (58 refusals, all about the device rather than the syntax)

The drop is #1597 (f49da6c5): it removed the backticked show interfaces status inactive from the prose because the console has no such view. Enumerating forms out of docs/CLI.md before and after that commit gives 48 then 47 forms, and the engine refuses the spelling:

[sw] show interfaces status inactive
% `status inactive` is a view, not a port: this console has no `show interfaces status inactive`. `show interfaces` prints every port s status and protocol, one block each.

So one documented form left the page and took two commands and two refusals with it, while the counts in the same paragraph stayed a form and two refusals ahead. The sentence explaining the show ip ospf refusal was re-checked and is still verbatim what the box says.

Change

48 to 47 forms, 96 to 94 commands, Sixty of the ninety-six to Fifty-eight of the ninety-four.

Guards

guard before after
syntax-check 338 files, all OK 338 files, all OK
docs-show-commands (docs-commands / help-forms sweep) 7 passed, 0 failed 7 passed, 0 failed (47 forms, 94 commands)
help-completeness (help-coverage) 8 passed, 0 failed 8 passed, 0 failed
check-control-bytes clean clean

Not done

test/docs-show-commands.test.js has a header comment that still says "44 forms today" - a third figure, stale since before the page had 47. It is a comment inside the guard, not documentation, so it is left for a code PR.

## What was untrue `docs/CLI.md`, section *Every `show` form on this page is typed by a test*, claimed: > types each form at a router and a switch — **48 forms, 96 commands today** … > **Sixty of the ninety-six** answers are refusals of that kind today ## Evidence Running the guard the paragraph describes prints the real numbers: ``` $ node test/docs-show-commands.test.js The documentation names 47 show forms, and the console answers every one: (94 commands typed across a router and a switch) (58 refusals, all about the device rather than the syntax) ``` The drop is #1597 (f49da6c5): it removed the backticked `show interfaces status inactive` from the prose because the console has no such view. Enumerating forms out of `docs/CLI.md` before and after that commit gives 48 then 47 forms, and the engine refuses the spelling: ``` [sw] show interfaces status inactive % `status inactive` is a view, not a port: this console has no `show interfaces status inactive`. `show interfaces` prints every port s status and protocol, one block each. ``` So one documented form left the page and took two commands and two refusals with it, while the counts in the same paragraph stayed a form and two refusals ahead. The sentence explaining the `show ip ospf` refusal was re-checked and is still verbatim what the box says. ## Change 48 to 47 forms, 96 to 94 commands, Sixty of the ninety-six to Fifty-eight of the ninety-four. ## Guards | guard | before | after | |---|---|---| | syntax-check | 338 files, all OK | 338 files, all OK | | docs-show-commands (docs-commands / help-forms sweep) | 7 passed, 0 failed | 7 passed, 0 failed (47 forms, 94 commands) | | help-completeness (help-coverage) | 8 passed, 0 failed | 8 passed, 0 failed | | check-control-bytes | clean | clean | ## Not done `test/docs-show-commands.test.js` has a header comment that still says "44 forms today" - a third figure, stale since before the page had 47. It is a comment inside the guard, not documentation, so it is left for a code PR.
docs(CLI): the show-form guard paragraph counts the forms that are left, not the one #1597 removed (#1614)
All checks were successful
CI / Classify the change (pull_request) Successful in 11s
PR rebase / Rebase onto main and arm auto-merge (pull_request) Successful in 16s
CI / Test (Node 18) (pull_request) Has been skipped
CI / Test (Node 20) (pull_request) Has been skipped
CI / Test (Node 22) (pull_request) Has been skipped
CI / Server smoke test (pull_request) Has been skipped
CI / Docker build (pull_request) Has been skipped
9484079b4e
The paragraph says 48 forms, 96 commands and sixty refusals. #1597 took the backticked `show interfaces status inactive` off the page because the console has no such view, so the same enumeration test now reads 47 forms, 94 commands and 58 refusals - the numbers in the prose were a form and two refusals ahead of the thing they describe.
jaylouisw scheduled this pull request to auto merge when all checks succeed 2026-11-16 06:18:53 +00:00
jaylouisw force-pushed docs/1116-0615 from 9484079b4e
All checks were successful
CI / Classify the change (pull_request) Successful in 11s
PR rebase / Rebase onto main and arm auto-merge (pull_request) Successful in 16s
CI / Test (Node 18) (pull_request) Has been skipped
CI / Test (Node 20) (pull_request) Has been skipped
CI / Test (Node 22) (pull_request) Has been skipped
CI / Server smoke test (pull_request) Has been skipped
CI / Docker build (pull_request) Has been skipped
to dcb78673ac
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 14s
CI / Test (Node 18) (pull_request) Has been skipped
CI / Test (Node 20) (pull_request) Has been skipped
CI / Test (Node 22) (pull_request) Has been skipped
CI / Server smoke test (pull_request) Has been skipped
CI / Docker build (pull_request) Has been skipped
2026-11-16 06:18:55 +00:00
Compare
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!1615
No description provided.