docs(CLI): the show census is 55 forms and 110 commands, not 54 and 108 #1888

Merged
jaylouisw merged 1 commit from docs/1117-1945 into main 2026-11-17 19:53:58 +00:00
Owner

docs/CLI.md describes test/docs-show-commands.test.js as typing "54 forms, 108 commands today", and "Sixty-six of the 108 answers are refusals". Both numbers are one form behind the page they claim to measure: #1886 added show vlan all-ports, and the sentence was not revisited.

Running the suite on this branch prints its own count:

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

So the page said 54/108/66 where its own guard measures 55/110/68. One form typed at two devices is two commands, and show vlan all-ports is refused on both the router and the switch with a sentence about the device, which is why the refusal count moves by two as well.

Doc-only: two numbers, no code. Same defect #1875 fixed for the help-coverage guard (100 quoted, 102 typed). The plan at docs/plans/doc-counts.md step 4 would make the suite assert these instead of leaving the page as a fourth hand count; this PR does not do that, it just stops the current sentence being wrong.

Guards on this branch: syntax-check 393 files OK; docs-show-commands 7 passed / 0 failed; docs-cli-transcript 4 / 0; help-completeness 8 / 0; no-form-help-key 81 / 0.

`docs/CLI.md` describes `test/docs-show-commands.test.js` as typing "54 forms, 108 commands today", and "Sixty-six of the 108 answers are refusals". Both numbers are one form behind the page they claim to measure: #1886 added `show vlan all-ports`, and the sentence was not revisited. Running the suite on this branch prints its own count: ``` The documentation names 55 show forms, and the console answers every one: (110 commands typed across a router and a switch) (68 refusals, all about the device rather than the syntax) ``` So the page said 54/108/66 where its own guard measures 55/110/68. One form typed at two devices is two commands, and `show vlan all-ports` is refused on both the router and the switch with a sentence about the device, which is why the refusal count moves by two as well. Doc-only: two numbers, no code. Same defect #1875 fixed for the help-coverage guard (100 quoted, 102 typed). The plan at `docs/plans/doc-counts.md` step 4 would make the suite assert these instead of leaving the page as a fourth hand count; this PR does not do that, it just stops the current sentence being wrong. Guards on this branch: syntax-check 393 files OK; docs-show-commands 7 passed / 0 failed; docs-cli-transcript 4 / 0; help-completeness 8 / 0; no-form-help-key 81 / 0.
docs(CLI): the show census is 55 forms and 110 commands, not 54 and 108
All checks were successful
CI / Classify the change (pull_request) Successful in 10s
PR rebase / Rebase onto main and arm auto-merge (pull_request) Successful in 9s
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 46s
CI / Test (Node 22) (pull_request) Successful in 51s
CI / Test (Node 18) (pull_request) Successful in 56s
CI / Arm auto-merge (pull_request) Successful in 19s
58007dd3a4
The paragraph that describes test/docs-show-commands.test.js quotes the numbers the
suite prints, and #1886 added a 55th form to the page (`show vlan all-ports`) without
revisiting them. Run today, the suite prints:

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

so the page's "54 forms, 108 commands" and "Sixty-six of the 108" are one form and two
refusals behind the page they claim to measure. Same defect #1875 fixed for the
help-coverage guard's 100/102.
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!1888
No description provided.