Repository navigation
docs: clarify MLI framing and length limits - #20
Merged
madflojo merged 1 commit intoSep 14, 2026
Merged
Conversation
Replace broken snippets with verified stream-framing examples, document format boundaries and 2EE semantics, and remove stale links. Keep future readers out of framing archaeology.
neelamb6
approved these changes
Sep 14, 2026
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
2 participants
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.
Summary
Clarify how SimpleMLI frames stream messages and document each format's supported length range. Replace broken copy-paste snippets with working examples so readers can skip the framing archaeology.
Changes
io.ReadFullfor fixed-size MLI and message readsgo testValidation
make buildmake testsmake lintgo vet ./...go test -run '^Example$' ./...gofmtgit diff --checkgo doc .Compatibility
Documentation and tests only. Public API and runtime behavior are unchanged.
Risk
Low. The main review concern is documentation accuracy against existing wire-format validation.