docs(architecture): the show interfaces view table holds thirteen words, not twelve #1858

Merged
jaylouisw merged 1 commit from docs/1117-1446 into main 2026-11-17 14:53:34 +00:00
Owner

docs/ARCHITECTURE.md, the section on show interfaces <keyword>.

What the page claimed

  • "Twelve words that are views under show interfaces in IOS" and "only the twelve view words take the new path".
  • "test/show-interfaces-view-keywords.test.js pins it, 71 checks".

What the code does

  • engine/cli.js:394 INTERFACES_VIEW_KEYWORDS holds thirteen entries. The thirteenth is brief, added in #1448 so that the bare interface alias is not rewritten into show interfaces brief; show interfaces brief answers with the same keyword sentence and names show ip interface brief. Measured: % briefis a view, not a port: this console has noshow interfaces brief. show ip interface brief is the one-line-per-port view ...
  • The suite prints 97 passed, 0 failed (node test/show-interfaces-view-keywords.test.js). 71 was its size at #1444; #1834 added 26 checks for the port-first spelling.
  • The same page already said "thirteen" and "97 checks" further down, so the file contradicted itself.

Change

  • the passage now names the thirteenth entry and why it is there;
  • the "only the twelve view words" rule now says "the view words in that table";
  • 71 -> 97 in the passage and in the ipv6-provenance neighbour list (same suite, second occurrence);
  • the checks sentence now accounts for the other 26 (the show interfaces <port> counters tails).

Guards (before -> after, unchanged): syntax-check 389 files OK -> 389 OK; docs-show-commands 7 -> 7; docs-cli-transcript 4 -> 4; help-completeness 8 -> 8; no-form-help-key 81 -> 81; help-key-is-not-a-value 40 -> 40. check-control-bytes and check-doc-citations (349 citations, 4 allowed suspects) pass.

Docs-only: no engine change.

`docs/ARCHITECTURE.md`, the section on `show interfaces <keyword>`. **What the page claimed** - "Twelve words that are views under `show interfaces` in IOS" and "only the twelve view words take the new path". - "`test/show-interfaces-view-keywords.test.js` pins it, 71 checks". **What the code does** - `engine/cli.js:394` `INTERFACES_VIEW_KEYWORDS` holds **thirteen** entries. The thirteenth is `brief`, added in #1448 so that the bare `interface` alias is not rewritten into `show interfaces brief`; `show interfaces brief` answers with the same keyword sentence and names `show ip interface brief`. Measured: `% `brief` is a view, not a port: this console has no `show interfaces brief`. `show ip interface brief` is the one-line-per-port view ...` - The suite prints **97 passed, 0 failed** (`node test/show-interfaces-view-keywords.test.js`). 71 was its size at #1444; #1834 added 26 checks for the port-first spelling. - The same page already said "thirteen" and "97 checks" further down, so the file contradicted itself. **Change** - the passage now names the thirteenth entry and why it is there; - the "only the twelve view words" rule now says "the view words in that table"; - 71 -> 97 in the passage and in the ipv6-provenance neighbour list (same suite, second occurrence); - the checks sentence now accounts for the other 26 (the `show interfaces <port> counters` tails). **Guards** (before -> after, unchanged): syntax-check 389 files OK -> 389 OK; docs-show-commands 7 -> 7; docs-cli-transcript 4 -> 4; help-completeness 8 -> 8; no-form-help-key 81 -> 81; help-key-is-not-a-value 40 -> 40. `check-control-bytes` and `check-doc-citations` (349 citations, 4 allowed suspects) pass. Docs-only: no engine change.
docs(architecture): the show interfaces view table holds thirteen words, and the suite holds 97 checks
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 8s
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 47s
CI / Test (Node 22) (pull_request) Successful in 49s
CI / Test (Node 18) (pull_request) Successful in 54s
CI / Arm auto-merge (pull_request) Successful in 16s
0dddf1879f
The passage on `show interfaces <keyword>` said the table was twelve words and that
`test/show-interfaces-view-keywords.test.js` pins it with 71 checks. The code has held a
thirteenth entry since #1448 - `brief`, added so that `show ip interface brief` is not
swallowed into `show interfaces brief` - and `show interfaces brief` answers with the same
keyword sentence (`INTERFACES_VIEW_KEYWORDS`, engine/cli.js:394). #1834 added 26 checks for
the port-first spelling, so the file now reports 97, and the same page already said thirteen
and 97 further down; the two counts are now one.

Also refreshed the duplicate 71 in the ipv6 provenance neighbour list.
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!1858
No description provided.