docs(connectors): the code table omitted four codes RULES declares #2384
No reviewers
Labels
No milestone
No project
No assignees
1 participant
Notifications
Due date
No due date set.
Dependencies
No dependencies set.
Reference
jaylouisw/packetforge!2384
Loading…
Add table
Add a link
Reference in a new issue
No description provided.
Delete branch "docs/1121-0647"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
What was untrue
docs/CONNECTORS.md— section Error and warning codes — is headed "Everything the rules engine can emit, and where it comes from", and it listed 25 codes.RULESinengine/validation.jsdeclares 28.Missing rows:
E_SERIAL_NO_CLOCK,E_SERIAL_TWO_CLOCKS,E_PROTOCOL_MISMATCH,W_SWITCHPORT_MISMATCH.Evidence
Each has a
{code, severity, description}entry inRULES(engine/validation.js:104,:109,:120,:187), andE_PROTOCOL_MISMATCHis emitted by the validator itself as well as passed through frommedia.canMate(). They enteredRULESinf0f0ea8c(#1662), which corrected the paragraph under the table and added the twovalidateTopologyrows but not these four — so the table has been short by four since that commit.The change
Four rows added, wording taken from each
descriptioninRULES; placement follows the table's existing grouping (serial pair beforeE_CONSOLE_TO_DATA,E_PROTOCOL_MISMATCHbeside the othercanMaterefusals,W_SWITCHPORT_MISMATCHafterW_HYBRID_CORD). Docs-only:docs/CONNECTORS.md, one hunk, no code or test touched.The table now holds 29 rows — the 28 in
RULESplusE_COMBO_OCCUPIED, which the paragraph below already documents as thetopology.jsexception — and every row's severity matches the table the validator reads.Gates
node scripts/syntax-check.jstest/docs-cli-transcript.test.jstest/docs-show-commands.test.jstest/no-form-help-key.test.jstest/help-completeness.test.jsshowviews)test/validation.test.js/test/property-validator.test.jsNot done
The
canMate()-only codesE_BAUD_MISMATCH,E_BIDI_MISMATCHandE_BIDI_SAME_WAVELENGTHare still absent from this table (one is described in prose further down the page, none is inRULES), anddocs/PHYSICAL_LAYER.mdsection 4 is further behindRULESthan this page was. Both are separate items; this PR fixes one table.