docs: fix two README inaccuracies in the TUI section#69
Merged
deviantintegral merged 2 commits intomainfrom Mar 5, 2026
Merged
docs: fix two README inaccuracies in the TUI section#69deviantintegral merged 2 commits intomainfrom
deviantintegral merged 2 commits intomainfrom
Conversation
Copilot
AI
changed the title
[WIP] Update README to match fireplace status functionality
docs: fix two README inaccuracies in the TUI section
Mar 4, 2026
- Remove false "auto-refreshes every 10 seconds" claim: the TUI has no auto-refresh (no set_interval call); refresh is manual via the `r` key. - Fix `t` key binding description from "Set timer" to "Toggle timer on/off" to match the code's action_toggle_timer behaviour. Co-authored-by: deviantintegral <255023+deviantintegral@users.noreply.github.com>
deviantintegral
force-pushed
the
copilot/update-readme-fireplace-status
branch
from
f37148c to
a4cc097
Compare
Owner
|
@copilot can you double check all code comments against the README, and the code, and make sure they're correct? |
The DashboardScreen class docstring in tui/screens.py still claimed "auto-refreshing every 10 seconds" — the same outdated text removed from the README. Updated to match the actual behaviour: refresh is triggered manually via the 'r' key binding. Co-authored-by: deviantintegral <255023+deviantintegral@users.noreply.github.com>
Contributor
Author
Done. Searched all source files for stale references — found one: the |
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.
tkey binding description in README (toggle, not set)DashboardScreen(tui/screens.py) that also claimed "auto-refreshing every 10 seconds"💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.