Split how-it-works key config; document max_polling_interval#17
Merged
Split how-it-works key config; document max_polling_interval#17
Conversation
The unified "Key configuration" table in how-it-works.md mixed broker-scoped (`timeline_key`, `payloads_key`) and subscriber-scoped (`polling_interval`, `max_concurrent`, `lease_ttl`) knobs and omitted `max_polling_interval` (default `5.0` s, see `schemas.py:11`). A reader trying to compute idle-queue latency from `polling_interval` alone would be off by orders of magnitude. Split the table into "Broker constructor" (adds `start_timeout`) and "Per-subscriber" (adds `max_polling_interval` with the `max_polling_interval × 1.5` worst-case latency note). Add `max_polling_interval` to the `@router.subscriber` example in `router.md` and a one-liner clarifying that all subscriber options are accepted by routers.
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 unified "Key configuration" table in how-it-works.md mixed broker-scoped (
timeline_key,payloads_key) and subscriber-scoped (polling_interval,max_concurrent,lease_ttl) knobs and omittedmax_polling_interval(default5.0s, seeschemas.py:11). A reader trying to compute idle-queue latency frompolling_intervalalone would be off by orders of magnitude.Split the table into "Broker constructor" (adds
start_timeout) and "Per-subscriber" (addsmax_polling_intervalwith themax_polling_interval × 1.5worst-case latency note).Add
max_polling_intervalto the@router.subscriberexample inrouter.mdand a one-liner clarifying that all subscriber options are accepted by routers.