docs(CLI): converge takes a bare millisecond instant, not at <ms> #1649

Merged
jaylouisw merged 1 commit from docs/1116-1046 into main 2026-11-16 10:53:00 +00:00
Owner

Docs-only. docs/CLI.md and the help index both promised converge [at <ms>]; _converge() (engine/cli.js:2719) has read Number(tokens[0]) since the command landed (#1050) and has no keyword handling for at.

Probed on a generic switch + PC lab:

  • converge 10000 -> the stp row is marked (pending)
  • converge at 10000 -> no mark, output identical to bare converge; Number("at") is NaN, so the pending test is skipped on every row

So the wrong form answers with a truthful-looking table rather than a refusal, which is why it survived: the missing thing is a column, not an error. This PR documents the spelling the parser takes and says the at spelling belongs to link ... at <ms>; the fix itself belongs in the parser, so the code is left alone in a docs-only branch.

Guards: syntax-check 348 files OK; helper counts unchanged (docs-show-commands 7 passed / 48 forms / 96 commands / 60 device refusals; help-completeness 8 passed / 98 advertised / 18 mechanisms / 16 shows; help-key 9 pass); check-control-bytes clean; check-doc-citations --strict 0 suspects introduced (351 citations, 16 judged).

Docs-only. `docs/CLI.md` and the `help` index both promised `converge [at <ms>]`; `_converge()` (`engine/cli.js:2719`) has read `Number(tokens[0])` since the command landed (#1050) and has no keyword handling for `at`. Probed on a generic switch + PC lab: - `converge 10000` -> the `stp` row is marked `(pending)` - `converge at 10000` -> no mark, output identical to bare `converge`; `Number("at")` is `NaN`, so the pending test is skipped on every row So the wrong form answers with a truthful-looking table rather than a refusal, which is why it survived: the missing thing is a column, not an error. This PR documents the spelling the parser takes and says the `at` spelling belongs to `link ... at <ms>`; the fix itself belongs in the parser, so the code is left alone in a docs-only branch. Guards: syntax-check 348 files OK; helper counts unchanged (docs-show-commands 7 passed / 48 forms / 96 commands / 60 device refusals; help-completeness 8 passed / 98 advertised / 18 mechanisms / 16 shows; help-key 9 pass); check-control-bytes clean; check-doc-citations --strict 0 suspects introduced (351 citations, 16 judged).
docs(CLI): converge takes a bare millisecond instant, not at <ms>
Some checks failed
CI / Classify the change (pull_request) Successful in 13s
PR rebase / Rebase onto main and arm auto-merge (pull_request) Successful in 17s
CI / Server smoke test (pull_request) Has been skipped
CI / Docker build (pull_request) Has been skipped
CI / Test (Node 18) (pull_request) Failing after 1m30s
CI / Test (Node 20) (pull_request) Failing after 1m29s
CI / Test (Node 22) (pull_request) Failing after 1m38s
8016827716
docs/CLI.md and the `help` index both advertised `converge [at <ms>]`, but
`_converge()` (engine/cli.js:2719) has read `Number(tokens[0])` since the
command landed (#1050): there is no keyword parser for `at`. Typing
`converge at 10000` therefore feeds `Number('at')` = NaN, every pending mark
is suppressed, and the table is printed as if no instant were given - a wrong
answer with no refusal, which is why the form survived.

The documented form is now the one the parser takes (`converge 10000`) and the
page says plainly that the `at` spelling belongs to `link ... at <ms>` and that
the fix is in the parser. Probed on a switch+PC lab: `converge 10000` marks the
stp row (pending), `converge at 10000` does not.
jaylouisw scheduled this pull request to auto merge when all checks succeed 2026-11-16 10:52:51 +00:00
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!1649
No description provided.