docs: fix stale comments and cross-doc contradictions from audit#103
Merged
Conversation
BulkheadFullError docstring named AsyncBulkhead specifically though both bulkheads raise it; AsyncClient.stream()'s "for v1" caveat contradicted the sync docstring and architecture/client.md; architecture/errors.md misstated where DecodeError wrapping happens (inline in send() rather than _BoundDecoder.decode); docs/testing.md said "httpx" where it meant the httpx2 package.
This was referenced Jul 13, 2026
lesnik512
added a commit
that referenced
this pull request
Jul 13, 2026
#105) ResponseTooLargeError's behavior was spelled out near-verbatim in docs/errors.md, architecture/errors.md, and architecture/client.md; architecture/errors.md now cross-references the other two instead of restating them. The "why not respx" paragraph was duplicated between docs/testing.md and architecture/testing.md, and the prior audit-fix pass (#103) had mechanically changed a "breaks across httpx major versions" claim to say httpx2 instead. Verified against respx's own README (requires httpx 0.25+, no stated httpx2 support) and GitHub history: the breakage claim is real but about httpx, not httpx2. Corrected the claim and deduped, keeping the full rationale in docs/testing.md.
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.
Summary
planning/audits/2026-07-13-docs-comments-audit.md— first pass covering source docstrings/comments (src/httpware/**) andarchitecture/**directly (the 2026-06-13 audit only covered user-facingdocs//README).planning/changes/2026-07-13.07-docs-comments-audit-fixes.md:BulkheadFullErrordocstring namedAsyncBulkheadspecifically, though bothBulkheadandAsyncBulkheadraise it.AsyncClient.stream()'s "for v1" caveat contradicted the sync docstring andarchitecture/client.md(which states the middleware bypass as permanent, not version-scoped).architecture/errors.mdsaidDecodeErrorwrapping happens inline inClient.send/AsyncClient.send; it actually happens in_BoundDecoder.decode(decoders/_resolver.py), matchingarchitecture/decoders.md.docs/testing.mdsaid "httpx" where every other reference (includingarchitecture/testing.md) sayshttpx2— a distinct package, not an alias.Test plan
just lint-ci— cleanuvx --with-requirements docs/requirements.txt mkdocs build --strict— cleanjust test— 780 passed, 100% coveragejust check-planning— OK