docs(ledmatrix-leaderboard): document all 56 settings, with real renders - #420
Open
ChuckBuilds wants to merge 1 commit into
Open
docs(ledmatrix-leaderboard): document all 56 settings, with real renders#420ChuckBuilds wants to merge 1 commit into
ChuckBuilds wants to merge 1 commit into
Conversation
31 of the 56 had no named key -- the whole global.appearance block, every
per-league entry under enabled_sports, and most of the scroll tuning. All 56
are now documented at the paths the schema expects; additionalProperties is
false, so a key at the wrong depth is rejected rather than ignored.
Three do nothing: global.scroll_speed_scale, global.scroll_direction and
global.enable_scroll_metrics. They appear nowhere in the plugin, and nowhere
in the core -- including src/common/scroll_helper.py, which is where a scroll
setting would plausibly be consumed. Marked in the README; schema untouched.
Corrects the opening description. It said the plugin "shows team rankings,
records, and statistics", but each team is drawn as position number, logo and
abbreviation. Reading the renderer, the number text is f"{index+1}." for every
league except NCAA football, where show_ranking chooses between the AP rank
and record_summary. So a record reaches the panel in exactly one configuration,
and no statistics do.
Adds real rendered screenshots: the ticker, text_outline and logo_scale, the
NCAA show_ranking swap, and four panel sizes. Standings are seeded onto the
plugin instance; last_update has to be seeded too or update() re-fetches and
clears them, and the renderer reads record_summary rather than record -- my
first fixture used the latter and no records appeared.
check_plugin.py: 8/8 pass.
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
31 of the 56 settings had no named key — the whole
global.appearanceblock, every per-league entry underenabled_sports, and most of the scroll tuning. All 56 are now documented at the paths the schema expects.additionalPropertiesisfalse, so a key at the wrong depth is rejected rather than ignored.Three settings do nothing
global.scroll_speed_scale,global.scroll_directionandglobal.enable_scroll_metricsappear nowhere in the plugin, and nowhere in the core — includingsrc/common/scroll_helper.py, which is where a scroll setting would plausibly be consumed rather than in the plugin itself. Marked in the README; I have not touched the schema.The other 53 are all read by the plugin or the core.
The opening description overstated what appears
It said the plugin "shows team rankings, records, and statistics in a scrolling ticker format". Reading the renderer, each team is drawn as position number, logo, abbreviation — and the number text is:
For NCAA football,
show_rankingchooses between the AP rank andrecord_summary. So a record reaches the panel in exactly one configuration, and no statistics do at all. The README now says that, with the two NCAA states pictured side by side:#2 BUFversus11-2 BUF.Images
The ticker,
text_outlineandlogo_scale, the NCAAshow_rankingswap, and four panel sizes.Two fixture notes now recorded in the shots file, both of which cost me a render cycle:
last_updatehas to be seeded, orupdate()re-fetches and clears the seeded standings.record_summary, notrecord. My first fixture usedrecordand no records appeared — the same class of mistake asnfl-draft'spick_number(docs(nfl-draft): document all 33 settings, with real renders #413).Checks
check_plugin.py: 8/8 passrender_docs_assets.py --check: all four images reproduceDocs only. 1.3.2 → 1.3.3.
🤖 Generated with Claude Code