docs: fix stale facts and plain up user-facing prose - #151
Merged
Merged
Conversation
Bring README, docs site, demos, SECURITY and contributing guide up to date with the circuit breaker and timeout middleware, fix misleading statements, and remove dash-heavy, bold-labelled, all-caps phrasing.
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.
Pass over the README, docs site, demos, SECURITY.md and the contributing guide.
Facts fixed
errors.mdcalledAsyncRetry"the default"; clients start with no middleware.AsyncRetryre-runs on every attempt.AsyncRetryresends the same request object, so the outer middleware runs once per call.event_hooksnote registered the decorated function as a hook; it now says to use the undecorated function on a caller-builthttpx2_client.[otel]and[all]extras._emit_event,_internal/redaction.py, the AGENTS.md admission check) and version-history wording ("0.6.0", "current behavior").CODE_OF_CONDUCT.md.Prose
Removed em dashes from prose, bold list labels, ALL-CAPS emphasis, dramatic one-line closers and curly quotes; headings and nav labels are sentence case. Demo walkthrough text is rewritten, including two strings in
engine.js.index.mdis reordered (first request, typed responses, resilience, streaming, then client options) without moving content to a new page, so inbound anchors still resolve.Outside docs
retry.pynow readshttpware: not retrying because the request body is a stream that cannot replay across attempts. Tests match on substrings and are unchanged; callers matching the exact note text would see the difference.pyproject.tomldescription: "Typed, resilient HTTP clients for Python, sync and async".Verification
just lint-ci,just test(955 passed),just docs-build(strict, no warnings),just adr-check.