docs(CLI): the show-form guard types 52 forms / 104 commands, 62 refusals #1780

Merged
jaylouisw merged 1 commit from docs/1117-0315 into main 2026-11-17 03:34:20 +00:00
Owner

The sentence in Every show form on this page is typed by a test still carried the counts from #1687: 51 forms, 102 commands, 60 refusals.

What was untrue

d4944d96 (#1776) added show ip dhcp pool to the DHCP prose in backticks. Every backticked show � span on this page is a form the guard types, so the page now holds 52 forms; typed at a router and a switch that is 104 commands, and since neither lab box is a DHCP server the new form is a device-level refusal on both, making 62 refusals.

Evidence: node test/docs-show-commands.test.js prints The documentation names 52 show forms, (104 commands typed across a router and a switch) and (62 refusals, all about the device rather than the syntax), and passes 7/0.

The same clause called the show ? and show ipv6 ? examples "the last two". The enumerator sorts its forms, so ? is the first entry and ipv6 ? sits mid-list; the two examples are now named without an ordering claim the code does not make.

Guards

  • node scripts/syntax-check.js - 373 files, all OK
  • test/docs-show-commands.test.js - 7/0 (before and after)
  • test/docs-cli-transcript.test.js - 4/0
  • test/help-completeness.test.js - 8/0
  • test/repo-paths.test.js - 8/0
  • test/doc-citations.test.js - 11/0
  • test/canonical-urls.test.js - 52/0

Docs-only; no engine change.

The sentence in **Every `show` form on this page is typed by a test** still carried the counts from #1687: 51 forms, 102 commands, 60 refusals. ### What was untrue `d4944d96` (#1776) added `show ip dhcp pool` to the DHCP prose in backticks. Every backticked `show �` span on this page is a form the guard types, so the page now holds **52** forms; typed at a router and a switch that is **104** commands, and since neither lab box is a DHCP server the new form is a device-level refusal on both, making **62** refusals. Evidence: `node test/docs-show-commands.test.js` prints `The documentation names 52 show forms`, `(104 commands typed across a router and a switch)` and `(62 refusals, all about the device rather than the syntax)`, and passes 7/0. The same clause called the `show ?` and `show ipv6 ?` examples "the last two". The enumerator sorts its forms, so `?` is the first entry and `ipv6 ?` sits mid-list; the two examples are now named without an ordering claim the code does not make. ### Guards - `node scripts/syntax-check.js` - 373 files, all OK - `test/docs-show-commands.test.js` - 7/0 (before and after) - `test/docs-cli-transcript.test.js` - 4/0 - `test/help-completeness.test.js` - 8/0 - `test/repo-paths.test.js` - 8/0 - `test/doc-citations.test.js` - 11/0 - `test/canonical-urls.test.js` - 52/0 Docs-only; no engine change.
docs(CLI): the show-form guard types 52 forms / 104 commands, 62 refusals (#1776 added one)
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 12s
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 57s
CI / Test (Node 18) (pull_request) Successful in 1m6s
CI / Test (Node 22) (pull_request) Successful in 1m5s
CI / Arm auto-merge (pull_request) Successful in 15s
0123a66627
The sentence in 'Every show form on this page is typed by a test' still carried
the counts from #1687 (51 forms, 102 commands, 60 refusals). d4944d96 added
`show ip dhcp pool` to the DHCP prose in backticks, and that span is a promise
the guard types like any other: one more form, two more commands (router and
switch), and two more device-level refusals, since neither lab box is a DHCP
server. The guard itself prints 52 / 104 / 62 and passes.

The same clause called the `show ?` and `show ipv6 ?` examples 'the last two',
which the enumerator never ordered that way (it sorts, so `?` is first) - the
two examples are now named without an ordering claim the code does not make.
jaylouisw force-pushed docs/1117-0315 from 0123a66627
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 12s
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 57s
CI / Test (Node 18) (pull_request) Successful in 1m6s
CI / Test (Node 22) (pull_request) Successful in 1m5s
CI / Arm auto-merge (pull_request) Successful in 15s
to a050517061
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 16s
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 57s
CI / Test (Node 22) (pull_request) Successful in 58s
CI / Test (Node 18) (pull_request) Successful in 1m6s
CI / Arm auto-merge (pull_request) Successful in 9s
2026-11-17 03:22:05 +00:00
Compare
jaylouisw scheduled this pull request to auto merge when all checks succeed 2026-11-17 03:32:21 +00:00
jaylouisw force-pushed docs/1117-0315 from a050517061
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 16s
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 57s
CI / Test (Node 22) (pull_request) Successful in 58s
CI / Test (Node 18) (pull_request) Successful in 1m6s
CI / Arm auto-merge (pull_request) Successful in 9s
to 35f7fa20b6
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 7s
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
CI / Arm auto-merge (pull_request) Has been skipped
2026-11-17 03:33: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!1780
No description provided.