docs(teslemetry): correct find_authorized_clients reliability claim#82
Merged
Conversation
The docstring and docs/teslemetry.md characterized the cloud authorized-clients check as "best-effort" with an implied staleness concern. The repo's own history shows the one confirmed anomaly (an intermittent null response body) was already root-caused and attributed to the Teslemetry API response, not the underlying Tesla command, and is already handled by raising InvalidResponse - there is no evidence backing a broader staleness/reliability claim about the command itself. Rewrite both to state what the accessor returns without the unevidenced reliability editorializing.
Merged
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.
Intent
find_authorized_clients()'s docstring (and the matching passage indocs/teslemetry.md) described the cloud authorized-clients check as "best-effort" with an implied staleness/malformed-data concernf801be1/f65ceb5), not the underlying Tesla command - and it's already handled by raisingInvalidResponsewith test coveragedocs/energy_local_control.mdandAGENTS.mdwere left as-is - their wording around the null-body issue is already correctly scoped to the Teslemetry response and evidenced, so nothing there needed correctingPipeline
Skipped per standing rule for docs-only changes in this repo - no behavior change, docstring/docs wording only. Ran locally instead:
uv run pytest tests(362 passed),uv run ruff check,uv run pyright(all clean).