docs: add README HTTP session, timeout, and retry examples - #263
Merged
Conversation
Expand the Quick Start area with practical copy-and-paste examples for shared Sessions, timeouts, Session injection, retries, and structured exceptions while linking to the detailed transport document. Co-authored-by: Matthew Spah <spahmatthew@gmail.com>
Mattsface
marked this pull request as ready for review
August 1, 2026 07:48
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.
Why
Version 0.8.0 adds shared Sessions, timeouts, Session injection, bounded retries, and structured transport exceptions. Users should be able to use those features from the README without reading the full transport document first.
What
HTTP Sessions, Timeouts, and Retriessection near Quick Startdocs/http-transport.mdfor the complete transport detailsTests
poetry run pythonpublic import assertions forMlband transport exception classespoetry run pytest tests/ --ignore=tests/external_tests(157 passed)git diff --checkREADME.mdchangedRisk and impact