docs(readme): drop compose() mention; it's not public API#15
Merged
Conversation
The README bullet under "Middleware foundation" named compose() as if it were a user-callable function. `compose` lives at `httpware._internal.chain.compose` per the seam-1 design — `Middleware` chain composition is an internal AsyncClient concern, not a consumer API. A user reading the bullet and trying `from httpware import compose` would hit ImportError. Replaces the compose() reference with a one-line note: "The chain is composed at AsyncClient construction; consumers don't compose chains themselves." Honest about how middleware is wired without exposing internal symbols. Co-Authored-By: Claude Opus 4.7 (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
Final-review catch on the 0.1.0 release-prep PR (#14): the README's middleware bullet named `compose()` as if it were public, but `compose` lives at `httpware._internal.chain.compose` per the seam-1 design. `from httpware import compose` raises `ImportError`.
This is exactly the "overpromising what's not shipped" failure mode the trim was supposed to prevent. One-line fix on the bullet that:
Caught by the opus review on PR #14 before the maintainer creates the GitHub Release tag. Lands cleanly so 0.1.0 ships honest README copy.
Test plan
🤖 Generated with Claude Code