Skip to content

docs: fix misleading timeout_ms description in README#20

Open
jimexist wants to merge 1 commit intomixedbread-ai:mainfrom
jimexist:fix/readme-timeout-description
Open

docs: fix misleading timeout_ms description in README#20
jimexist wants to merge 1 commit intomixedbread-ai:mainfrom
jimexist:fix/readme-timeout-description

Conversation

@jimexist
Copy link
Copy Markdown

@jimexist jimexist commented Apr 8, 2026

Summary

  • Fixed the timeout_ms description in the README that incorrectly described it as "the maximum time to wait for more requests before processing the batch"
  • The actual behavior is a fixed sleep per loop iteration when the batch is not full — there is no early wake-up mechanism when the batch fills during the sleep
  • Updated wording to match the accurate docstrings in the source code

Test plan

  • Verify the new description matches the implementation in batch_generator.py and aio/batch_generator.py

🤖 Generated with Claude Code

The README described timeout_ms as "the maximum time to wait for more
requests before processing the batch", implying an early wake-up on a
full batch. In reality, it is a fixed sleep per loop iteration when
the batch is not full. Updated to match the accurate docstrings.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant