docs: correct request_timeout default in README (#93)#102
Merged
Conversation
The README documented `request_timeout` default as 10s, but the actual default across all public construction paths (ConnectionConfig, ConnectionConfig.from_url, HAClient.from_url, SyncHAClient.from_url) is 30s. Update the README to match the code.
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.
Closes #93
Issue validity assessment
Valid and actionable. Verified the documented default in
README.md(10) does not match the actual default in code (30.0) across all public construction paths:ConnectionConfig.request_timeout(src/haclient/config.py:73)ConnectionConfig.from_url()(src/haclient/config.py:86)HAClient.from_url()(src/haclient/api.py:150)SyncHAClient.from_url()(src/haclient/sync.py:208)Other docs (
docs/guides/lifecycle.md,docs/guides/sync-wrapper.md) already reflect the correct value; only the README was wrong.Fix
One-line change in
README.md:10->30.The issue's optional suggestion of adding a config summary to
docs/index.mdwas deferred — it is a docs-shape change beyond the scope of the bug, and the existing per-guide docs already document timeout behavior consistently with the code.Checks run
ruff check src tests— passedruff format --check src tests— passed (60 files)mypy src— passed (38 files, strict)pytest tests/ --cov=haclient --cov-fail-under=95— 329 passed, 97.19% coverage