Default leave_dark_blue to true in runtime config #56

Merged
JackFrostbyte merged 2 commits from fix/issue-47-leave-dark-blue-default-docs into develop 2026-05-15 17:55:50 -04:00
Collaborator

Summary

  • Flips config/runtime_config.json leave_dark_blue from false to true, applying the preferred direction stated in the issue body.
  • This resolves the mismatch where docs/safe-failure-modes.md describes dark-blue shutdown restore as a safety goal but the shipped config disabled it by default.
  • Manual python -m rgb_aura.main runs now match the documented behavior without requiring a CLI flag.
  • Systemd users see no behavior change: systemd/user/rgb-aura.service already passes --leave-dark-blue explicitly, which continues to work and now matches the config default.

Files changed

  • config/runtime_config.json (1 line)

Why no other files changed

  • Docs scan: grep -n "default" docs/safe-failure-modes.md docs/usage.md docs/systemd-user-service.md returns nothing. No doc explicitly states the previous default value, so no doc text contradicts the new default. All existing dark-blue descriptions are generic ("RGB Aura attempts to restore...", "should try to leave in a known dark-blue state") and remain accurate.
  • Examples: docs/usage.md examples include --leave-dark-blue explicitly. The flag is now technically redundant but still does what users expect. Left unchanged so usage examples stay consistent with the systemd unit (which also still passes the flag explicitly).
  • Systemd unit: out of scope per the issue body. The unit's explicit --leave-dark-blue flag is now redundant but harmless. If the redundancy is worth cleaning up, that belongs in a separate issue.

Verification

  • ruff format src tests scripts — 29 files left unchanged.
  • ruff check src tests scripts — all checks passed.
  • python -m pytest tests/ — 1 passed.
  • python -m rgb_aura.main --dry-run --dry-run-events 3 — clean run; output now shows Leave dark blue on exit: True in the runtime options preview.

Hardware verification

Not required. Config-only change. No runtime code paths, no LED write path, no animation logic touched.

Linked issue

Closes #47.

Branch workflow

  • Base branch: develop
  • Work branch: fix/issue-47-leave-dark-blue-default-docs
  • Pull request target: develop
  • Not merged directly into main.
## Summary - Flips `config/runtime_config.json` `leave_dark_blue` from `false` to `true`, applying the preferred direction stated in the issue body. - This resolves the mismatch where `docs/safe-failure-modes.md` describes dark-blue shutdown restore as a safety goal but the shipped config disabled it by default. - Manual `python -m rgb_aura.main` runs now match the documented behavior without requiring a CLI flag. - Systemd users see no behavior change: `systemd/user/rgb-aura.service` already passes `--leave-dark-blue` explicitly, which continues to work and now matches the config default. ## Files changed - `config/runtime_config.json` (1 line) ## Why no other files changed - **Docs scan:** `grep -n "default" docs/safe-failure-modes.md docs/usage.md docs/systemd-user-service.md` returns nothing. No doc explicitly states the previous default value, so no doc text contradicts the new default. All existing dark-blue descriptions are generic ("RGB Aura attempts to restore...", "should try to leave in a known dark-blue state") and remain accurate. - **Examples:** `docs/usage.md` examples include `--leave-dark-blue` explicitly. The flag is now technically redundant but still does what users expect. Left unchanged so usage examples stay consistent with the systemd unit (which also still passes the flag explicitly). - **Systemd unit:** out of scope per the issue body. The unit's explicit `--leave-dark-blue` flag is now redundant but harmless. If the redundancy is worth cleaning up, that belongs in a separate issue. ## Verification - [x] `ruff format src tests scripts` — 29 files left unchanged. - [x] `ruff check src tests scripts` — all checks passed. - [x] `python -m pytest tests/` — 1 passed. - [x] `python -m rgb_aura.main --dry-run --dry-run-events 3` — clean run; output now shows `Leave dark blue on exit: True` in the runtime options preview. ## Hardware verification Not required. Config-only change. No runtime code paths, no LED write path, no animation logic touched. ## Linked issue Closes #47. ## Branch workflow - Base branch: `develop` - Work branch: `fix/issue-47-leave-dark-blue-default-docs` - Pull request target: `develop` - Not merged directly into `main`.
JackFrostbyte deleted branch fix/issue-47-leave-dark-blue-default-docs 2026-05-15 17:55:50 -04:00
Sign in to join this conversation.
No reviewers
No labels
No milestone
No project
No assignees
2 participants
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
JackFrostbyte/rgb-aura!56
No description provided.