Clarify runnable Rust docs#62
Open
nficano wants to merge 2 commits into
Open
Conversation
Add doctest-backed examples to ARCPClient::new, Envelope, ARCPRuntime::builder, and the transport/paired module so the rendered API docs each include a compilable snippet. Refine the jobs/resume/examples READMEs to point at the runnable example crates rather than the illustrative resumability sketch. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
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.
Update the Rust docs to stop referencing the nonexistent event_seq field, switch getting-started to runnable examples, and correct the example index/count and handshake terminology.