contracts: rewrite embedder-api.md for semantic density - #277
Merged
Conversation
Restyle the host-facing contract after the Component Model Explainer: a table of contents, terse rule lists, mapping tables, and interface blocks in place of argued prose. Every section heading cited by code comments (`§"..."`) is preserved verbatim; the import marks and `sync()` become subsections of "Functions and async", the direct-access byte edges a subsection of "Streams and futures", and "Bindgen obligations" folds into "Implementation strategy" (its one citation in crates/bindgen updated). No normative rule is added or removed; the `StreamWriter` interface, previously prose, is spelled out from protocol/src/handles.ts. 1390 -> ~930 lines, 11.6k -> 6.8k words.
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.
Restyles
contracts/embedder-api.mdafter the Component Model Explainer: TOC, terse rule lists, mapping tables, interface blocks in place of argued prose.§"Streams and futures"etc.) is preserved verbatim.sync()become subsections of "Functions and async"; direct-access byte edges a subsection of "Streams and futures"; "Bindgen obligations" folds into "Implementation strategy" (its one citation incrates/bindgen/src/codegen.rsupdated).StreamWriterinterface, previously prose, is spelled out fromprotocol/src/handles.ts.Gates:
just version-guard-local,cargo checkon the bindgen crate.Automerge armed.