Repository navigation
docs: describe the serializer and escalations as scoped - #158
Merged
Merged
Conversation
- README: drops "The serializer always writes spec-clean Part 10." from the tolerance bullet; the Tier 0 row reads "No deviation detected"; escalations are "a stricter posture". - intro: the writer "emits a correct File Meta group length, even-length values and proper padding"; escalations are "a stricter posture". - profiles notes: escalations are "a stricter posture for a trusted sender". - tolerance notes: "the serializer is conservative". - serialization: the page is "Serializing Part 10"; the writer "applies the guarantees below" and "throws only with one of the codes below". - cookbook: escalation is "a stricter gate for a trusted sender". - troubleshooting: on DICOM_VR_MISMATCH the on-wire VR is used and the warning recorded. - limitations: the index row reads "Writing bytes back out". Checked on the published 0.1.0 from a clean install: a parsed synthetic object re-serializes with the preamble, DICM, an even length and no warnings on re-parse, and SERIALIZE_ERROR_CODES holds the five codes the serialization page lists. Claude-Session: https://claude.ai/code/session_011dC8vE9axM3hqC8rNEX3W9
The docs-content structure test bans a literal count beside "codes". 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
1 participant
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 about the writer and about escalation says what the package states elsewhere in detail (the serialization page's "What the writer guarantees" list and its error codes). Checked on the published
@cosyte/dicom0.1.0 from a clean install outside any repository: a parsed synthetic object re-serializes with the 128-byte preamble,DICM, an even total length and no warnings on re-parse, andSERIALIZE_ERROR_CODESholds the five codes the serialization page lists.DICOM_VR_MISMATCHrow)The serialization page title still matches
/serializ/, whichdocs-content-structure.test.tsrequires; no runnable block changes;prettier --check README.mdpasses, and the table rows keep their column widths.https://claude.ai/code/session_011dC8vE9axM3hqC8rNEX3W9