Repository navigation
docs: describe the builders and strict mode as scoped - #165
Merged
Merged
Conversation
- README Emit bullet: ends at "a domain builder (build835, build837P, build271, and the rest)." - intro: "a lenient reader and a spec-clean domain builder" becomes "a lenient reader and a domain builder"; "the builders emit spec-clean X12 and refuse (never silently corrupt) a structurally impossible spec" becomes "the builders refuse (never silently corrupt) a structurally impossible spec". - transaction sets: "a spec-clean domain builder" becomes "a domain builder". - emit and serialize: a builder refuses "where it meets one of the specs listed below"; the closing sentence ends at "a wrong payment". - tolerance: "Tier 1: spec-clean" becomes "Tier 1: no deviation flagged"; a strict run "fails on every deviation the parser flags". - cookbook: strict mode is "useful as a gate on a trusted trading partner". Claude-Session: https://claude.ai/code/session_011dC8vE9axM3hqC8rNEX3W9
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Wording changes in the README and docs-content so each sentence says exactly what the builders and strict mode do. Checked on the published
@cosyte/x120.1.1 from a clean install outside any repository:buildInterchangerefuses an empty interchange control number and a?delimiter withX12_BUILD_INVALID_SPEC(two of the cases the emit page lists);{ strict: true }throws anX12ParseErrorcarrying the same code a lenient parse records (X12_TRANSACTION_COUNT_MISMATCH,X12_PRE_005010); and with CLP-04 450.00 and a PLB of +50.00, a BPR-02 of 400.00 balances while 500.00 raisesX12_835_REMIT_BALANCE_MISMATCH, as these pages state.build835,build837P,build271, and the rest) that layers that guide's own invariants on top.build835,build837P,build271, and the rest).No runnable block changes; the emit page keeps the words
docs-content.test.tsrequires ("refuse", "silently corrupt").prettier --checkpasses on every changed file. The README's description paragraph is left as it is, becausereadme-standard.test.tsholds it equal to the package.jsondescription, which changes only with a release.https://claude.ai/code/session_011dC8vE9axM3hqC8rNEX3W9