docs: close delta-audit doc-consistency findings (2 Low + 4 Nit)#47
Merged
Conversation
Batches the doc-staleness tail from planning/audit/2026-06-12-delta-audit.md: - README.md: typed decoding works with either the pydantic OR msgspec extra (was pydantic-only; 0.9.0 added msgspec response_model= parity). - docs/index.md: decoder-dispatch snippet now imports PydanticDecoder / MsgspecDecoder (+ AsyncClient) so it runs as copied. - docs/errors.md: MissingDecoderError hint strings now match errors.py verbatim (backticks around pip commands + the trailing 'Pass a custom decoder via decoders=[...].' sentence). - planning/deferred-work.md: the module-global lru_cache item is resolved by PR #42 (per-instance caches); moved from Open to a new Resolved section. - planning/engineering.md: §1 docs URL retargeted from the stale readthedocs.io to httpware.modern-python.org (GitHub Pages). - CLAUDE.md: exception-construction rule scoped to StatusError subclasses, mirroring engineering.md §4 (non-status ClientError subclasses do define keyword-only __init__). Docs-only; no code change. Co-Authored-By: Claude Fable 5 <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
Batches the doc-staleness tail from the 0.9.0 delta audit (
planning/audit/2026-06-12-delta-audit.md) into one sweep. Docs-only, no code.README.mdpydanticormsgspecextra (0.9.0 gave msgspecresponse_model=parity)docs/index.mdPydanticDecoder/MsgspecDecoder(+AsyncClient) so it runs as copied — no moreNameErrorMissingDecoderErrorhint mismatch (Nit)docs/errors.mderrors.pyverbatim — backticks around thepip installcommands + the truncated trailingPass a custom decoder via decoders=[...].planning/deferred-work.mdlru_cacheitem was resolved by PR #42 (per-instance caches); moved Open → new Resolved sectionplanning/engineering.mdreadthedocs.iotohttpware.modern-python.org(GitHub Pages)CLAUDE.mdStatusErrorsubclasses, mirroringengineering.md§4 (non-statusClientErrorsubclasses do define keyword-only__init__)Each fix verified against the live code (
errors.pymessage builder, theResponseDecoderdispatch, the per-instance caches) and the canonicalengineering.md.Test Plan
just lintclean (eof-fixer + ruff + ty)CLAUDE.md,README.md,docs/*.md,planning/*.mddocs/index.mdsnippet imports resolve against the real module pathsdocs/errors.mdhints match_missing_decoder_summaryinerrors.pybyte-for-byte🤖 Generated with Claude Code