docs: update Backend protocol listing in architecture guide - #50
Open
rcbevans wants to merge 1 commit into
Open
Conversation
The protocol code block was missing 10+ methods that were added in recent releases (enqueue_batch, poll_reclaim_events, schedule CRUD, get_actor_max_pending, count_pending_jobs). Updated to reflect the complete Backend protocol as of BACKEND_PROTOCOL_VERSION 3.
rcbevans
force-pushed
the
chore/docs-architecture
branch
from
July 30, 2026 04:59
5fa4aa0 to
f6ec7c9
Compare
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.
The Backend protocol code block in
docs/architecture.mdlisted ~20 methods but the actualBackendprotocol insrc/taskq/backend/_protocol.pyhas 33+ methods. Third-party backend implementers reading the docs would not see the full contract.Missing methods added:
enqueue_batch,enqueue_batch_fast— batched enqueue and COPY FROM fast-pathget_events,poll_reclaim_events— job event reads and crash-reclaim event pollingcount_pending_jobs— pending+scheduled counts per actorget_actor_max_pending— stored max_pending per actor (required as of protocol v3)create_schedule,list_schedules,update_schedule,delete_schedule— schedule CRUDAlso expanded the existing method signatures to show full parameter lists with type hints and default values, so the listing matches the actual protocol contract without needing to open the source file. Added brief inline comments for non-self-explanatory methods.
Verified with
uv run mkdocs build --strictanduv run ruff check ..