docs(CLI): the help-key suite is ten checks, not the nine the page quotes #1793

Merged
jaylouisw merged 1 commit from docs/1117-0515 into main 2026-11-17 05:19:23 +00:00
Owner

What was untrue

docs/CLI.md (the ? / exit section, under A no that names one thing must not remove anothers predecessor) said:

test/help-key-works-in-every-prompt.test.js holds it: nine checks over all five prompts ..., plus the full exit ladder and the unknown-word reports. With the old handler: 4 passed / 5 failed.

Evidence from the code

node test/help-key-works-in-every-prompt.test.js reports tests 10 / pass 10 / fail 0. The ten are:

  1. ? answers with the index at user EXEC
  2. ? answers with the index at privileged EXEC
  3. ? answers with the index at config
  4. ? answers with the index at interface
  5. ? answers with the index at dhcp pool
  6. help in a mode does not swallow the next command
  7. a verb the console does not know is still reported in every mode
  8. exit walks up the ladder, including out of privileged EXEC
  9. the rest of the ladder still climbs down one level at a time
  10. ? after show answers with the views, not with an invalid command

The count went stale in #1679, which added check 10 while this sentence kept the nine that #1504 shipped. The paragraph directly above the sentence is about the show ? listing, so the check it added was the one left uncounted.

The fix

Count corrected to ten, the show ? check named, and the historical 4 passed / 5 failed scoped to the nine it was measured on (that measurement predates check 10, so it cannot be restated for ten).

Guards (before / after: identical, prose-only change)

  • node scripts/syntax-check.js � 375 files, all OK
  • docs-syntax (test/docs-cli-transcript.test.js) � 4 passed
  • docs-commands (test/docs-show-commands.test.js) � 7 passed
  • help-forms (test/no-form-help-key.test.js) � 81 passed
  • help-coverage (test/help-completeness.test.js) � 8 passed
  • also: control-bytes clean, doc-citations 11, doc-catalog-counts 43

No transcript touched.

## What was untrue `docs/CLI.md` (the `?` / `exit` section, under **A `no` that names one thing must not remove another**s predecessor) said: > `test/help-key-works-in-every-prompt.test.js` holds it: **nine checks** over all five prompts ..., plus the full `exit` ladder and the unknown-word reports. With the old handler: 4 passed / 5 failed. ## Evidence from the code `node test/help-key-works-in-every-prompt.test.js` reports `tests 10 / pass 10 / fail 0`. The ten are: 1. `?` answers with the index at user EXEC 2. `?` answers with the index at privileged EXEC 3. `?` answers with the index at config 4. `?` answers with the index at interface 5. `?` answers with the index at dhcp pool 6. help in a mode does not swallow the next command 7. a verb the console does not know is still reported in every mode 8. exit walks up the ladder, including out of privileged EXEC 9. the rest of the ladder still climbs down one level at a time 10. `?` after `show` answers with the views, not with an invalid command The count went stale in #1679, which added check 10 while this sentence kept the nine that #1504 shipped. The paragraph directly above the sentence is about the `show ?` listing, so the check it added was the one left uncounted. ## The fix Count corrected to ten, the `show ?` check named, and the historical `4 passed / 5 failed` scoped to the nine it was measured on (that measurement predates check 10, so it cannot be restated for ten). ## Guards (before / after: identical, prose-only change) - `node scripts/syntax-check.js` � 375 files, all OK - docs-syntax (`test/docs-cli-transcript.test.js`) � 4 passed - docs-commands (`test/docs-show-commands.test.js`) � 7 passed - help-forms (`test/no-form-help-key.test.js`) � 81 passed - help-coverage (`test/help-completeness.test.js`) � 8 passed - also: control-bytes clean, doc-citations 11, doc-catalog-counts 43 No transcript touched.
docs(CLI): the help-key suite is ten checks, not the nine the page quotes
All checks were successful
PR rebase / Rebase onto main and arm auto-merge (pull_request) Successful in 6s
CI / Classify the change (pull_request) Successful in 10s
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 50s
CI / Test (Node 18) (pull_request) Successful in 58s
CI / Test (Node 22) (pull_request) Successful in 56s
CI / Arm auto-merge (pull_request) Successful in 12s
797f931419
`test/help-key-works-in-every-prompt.test.js` runs ten tests today: five
prompt checks, help-not-swallowing-the-next-command, the unknown-word
reports, the two `exit` ladder checks, and the `show ?` view listing that
#1679 added after this paragraph was written. The page still quoted nine
and left the `show ?` check uncounted, so the historical 4 passed / 5
failed is now scoped to the nine it was measured on.

Measured: node test/help-key-works-in-every-prompt.test.js -> 10 tests,
10 pass, 0 fail.
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!1793
No description provided.