Repository navigation
docs: car_charging_from_battery must be Off to hold the battery for the car - #5897
Merged
Merged
Conversation
…he car The Hold for car status and the customisation switch list described the switch backwards. It defaults to Off, and Off is what holds the battery while the car charges (execute.py and plan.py hold only when it is not set); On lets the car drain the battery. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
springfall2008
commented
Oct 31, 2026
springfall2008
left a comment
springfall2008
left a comment
Owner
Author
There was a problem hiding this comment.
Automated comment from the triage bot.
Review of head commit b70573bd — clean, no findings. Both corrected sentences now match the code, and the PR fixes the only two inverted descriptions in docs/.
What I checked:
- Default:
car_charging_from_batterydefaults toFalse(apps/predbat/config.py:972), so "Off (the default)" indocs/customisation.md:328is correct. - Hold polarity: every hold gate keys on
not self.car_charging_from_battery—apps/predbat/plan.py:1283,plan.py:4299,plan.py:4405,plan.py:4721,apps/predbat/prediction.py:928,apps/predbat/execute.py:955— so "requires ... to be Off" indocs/what-does-predbat-do.md:118and "when Off, Predbat holds the battery" are correct, and On letting the car drain the battery is correct. - Completeness: I grepped all of
docs/forcar_charging_from_battery; every other mention already describes the correct direction (docs/car-charging.md:45,:48,:222,:1045-1046,:1057;docs/predbat-plan-card.md:100;docs/apps-yaml.md:2206;docs/customisation.md:195), and these two lines were the only inverted ones. The detailed nuances (discharge rate 0 only with a timed pause or outside a charge window, perdocs/car-charging.md:1047-1048) live on the Car Charging page this list entry links to, so the one-line summary level is right.
Docs only, no new page, so no mkdocs.yml or CONFIG_ITEMS change is needed; no test coverage obligation applies to a doc fix.
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
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.
Two lines in the docs describe
switch.predbat_car_charging_from_batterybackwards:what-does-predbat-do.md: Hold for car said it "requires …car_charging_from_batteryto be set to On".customisation.md: the switch list said it would "prevent the car from draining the home battery".The switch defaults to Off (
config.py), and Off is what holds the battery while the car charges:execute.pyandplan.pyonly hold whennot self.car_charging_from_battery. On lets the car drain the battery, which is howcar-charging.mdalready describes it.Docs only.
🤖 Generated with Claude Code