docs: close deep-audit documentation-accuracy findings#66
Merged
Conversation
- architecture/client.md: document Client.stream() alongside AsyncClient.stream() (M4); attribute the httpx2 send to the internal _terminal, not .send() (L13). - errors.py docstring: list all four auto-raise sites, not just AsyncClient's terminal (Nit4). - architecture/extras.md: sync the pydantic constraint to >=2.0,<3.0 (Nit15). - docs/middleware.md + recipes/phase-decorator-patterns.md: import root-__all__ symbols via `from httpware import X` (Nit14). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
lesnik512
added a commit
that referenced
this pull request
Jun 14, 2026
All 35 confirmed 2026-06-14 deep-audit findings are remediated across #62-#66. Promote the four remaining bundles (deep-audit umbrella + correctness/test-quality/doc-fixes) to changes/archive/ with status: shipped, pr, and outcome filled; Active is now empty. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
lesnik512
added a commit
that referenced
this pull request
Jun 14, 2026
Add 0.11.0 release notes (security redaction, bounded error bodies + ResponseTooLargeError, correctness fixes, middleware __all__, test/doc quality — the full 2026-06-14 deep-audit remediation, #62–#66). Reset the static pyproject version to the placeholder "0": releases are tag-driven (publish.yml runs `uv version $GITHUB_REF_NAME` from the tag), so the field was stale at 0.3.0 against the 0.10.1 release history. Co-Authored-By: Claude Opus 4.8 (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.
Summary
Closes the remaining confirmed documentation-accuracy findings from the 2026-06-14 deep audit.
architecture/client.mdstreaming section omittedClient.stream()→ documents both sync + asyncstream()architecture/client.mdmisattributed thehttpx2.*.sendcall toClient.send/AsyncClient.send→ corrected to the internal_terminal(.send()enters the chain first)errors.pydocstring named onlyAsyncClient's terminal as the auto-raise site → now lists all four (both terminals + bothstream())architecture/extras.mdshowedpydantic>=2without the<3.0ceiling → synced topydantic>=2.0,<3.0docs/middleware.md+recipes/phase-decorator-patterns.mdimported root-__all__symbols via submodule paths → standardized tofrom httpware import X(Nit2 — the
_is_streaming_body_asyncreliance note — is moot: #64 symmetrized the code instead of documenting the reliance.)This is the final batch of the deep-audit remediation (after #62, #63, #64, #65).
Test plan
just lint-ciclean (CI-exact);just test— 656 passed, 100% coverage🤖 Generated with Claude Code