docs: fix README statements that disagree with the code - #94
Merged
Merged
Conversation
- MANUAL is required for concurrent processing; other policies pass through instead of being enforced. - commit_batch_size is a trigger threshold on pending tasks, not a max. - The rebalance flush timeout kwarg is rebalance_flush_timeout_sec. - Mark KafkaConcurrentHandler and KafkaBatchCommitter as internal. - Drop version-history wording and the migration section; keep the try/finally advice under Shutdown. - Plainer wording on signals and direct ack/nack/reject calls.
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.
Summary
The README described some behavior differently from what the code does. README-only change.
Changes
AckPolicy.MANUALat runtime._classifyinmiddleware.py(~line 171) returns_PassThrough()for any non-MANUAL policy, as the next README paragraph already says. Now: required for concurrent processing; other policies pass through untouched.commit_batch_sizewas documented as "Max messages per commit batch" and the example comment said "completed tasks"._commit_scheduler.py:73commits whenpending_len >= batch_size, wherepending_lencounts absorbed tasks (_pending_state.py:128-133), so it is a trigger threshold on pending tasks and a commit can include more.flush_timeout_sec; the public kwarg isrebalance_flush_timeout_sec(middleware.py:262).KafkaConcurrentHandlerandKafkaBatchCommitterwere presented as core concepts but are not exported from__init__.py; the section now says they are internal.try/finallyonCancelledErroradvice moved under Shutdown.ack()/nack()/reject()limitation; removed a redundant closing sentence in Other limitations.Both README Python blocks byte-compile; the Quick Start ran end to end under
TestKafkaBroker(withKafkaBroker(...)replaced byKafkaBroker()).Checklist
ruff)ty)uv build) if packaging or build config changeddescription, profile blurb) if this touches packaging