docs(cricket-scoreboard): document all 50 settings, with real renders - #416
Open
ChuckBuilds wants to merge 1 commit into
Open
docs(cricket-scoreboard): document all 50 settings, with real renders#416ChuckBuilds wants to merge 1 commit into
ChuckBuilds wants to merge 1 commit into
Conversation
The configuration table summarised settings in groups -- "customization",
"background_service", "display_modes" -- which read well but left 31 of the 50
without a named key. Every font and colour, the worker and retry tuning, the
per-mode duration overrides and the three mode toggles had no path you could
copy into config.json. The full list now sits alongside the existing overview,
at the exact paths the schema expects; additionalProperties is false, so a key
at the wrong depth is rejected rather than ignored.
mode_durations deserves a note, because the obvious check gets it wrong. A
config-access grep says it is dead: nothing reads
mode_durations.live_mode_duration. It is read at manager.py:365 through a key
built at runtime -- f"{mode}_mode_duration" -- so the literal never appears in
the source. It is live, and the README says what it does.
Adds real rendered screenshots of all three display modes, the show_venue
toggle and four panel sizes. Matches are seeded onto the plugin instance;
_last_update has to be seeded too or display() re-fetches and clears them.
Two things I checked and did not report, having measured rather than trusted
the eye: the two score lines look superimposed at a glance but occupy rows
5-14 and 16-25, and the top label looks clipped but is drawn flush at y=0 with
nothing lost. The only real contact is a single row between the lower score
and the detail line, which is not worth a change.
check_plugin.py: 24/24 pass across all three modes and eight panel sizes.
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Contributor
|
Important
This repository does not receive automatic reviews because it has fewer than 10 stars. ⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Team Run ID: Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Up to standards ✅🟢 Issues
|
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.
What was missing
The configuration table summarised settings in groups — one row each for
customization,background_service,display_modes,dynamic_duration— which reads well but left 31 of the 50 without a named key. Every font and colour, the worker/timeout/retry tuning, the per-mode duration overrides and the three mode toggles had no path you could copy intoconfig.json.The complete list now sits alongside the existing overview, at the exact paths the schema expects.
additionalPropertiesisfalse, so a key at the wrong depth is rejected rather than ignored — worth stating, since that is what bitolympics(#411) andodds-ticker(#415).mode_durationslooks dead and isn'tWorth recording, because the standard check gets it wrong. A config-access grep finds nothing reading
mode_durations.live_mode_duration, in this plugin or the core. It is read atmanager.py:365:The key is built at runtime, so the literal never appears in the source. Eight plugins declare this block; I nearly filed three dead settings against it.
Everything else in this plugin is read by either the plugin or the core.
Images
All three display modes, the
show_venuetoggle, and four panel sizes. Matches are seeded onto the plugin instance —_last_updatehas to be seeded too, ordisplay()re-fetches and clears them.Two things I checked and did not report
Both looked like bugs and were not, which is only clear once measured:
FINALandODIhave flat tops. It is drawn aty=0, flush with the edge, with nothing above the panel. Nothing is lost.I had written both up as defects before checking.
Checks
check_plugin.py: 24/24 pass — three modes across eight panel sizesrender_docs_assets.py --check: all four images reproduceDocs only. 1.1.1 → 1.1.2.
🤖 Generated with Claude Code