docs(nrl-scoreboard): document all 131 settings, with real renders - #425
Open
ChuckBuilds wants to merge 1 commit into
Open
docs(nrl-scoreboard): document all 131 settings, with real renders#425ChuckBuilds wants to merge 1 commit into
ChuckBuilds wants to merge 1 commit into
Conversation
The README covered roughly 55 of the plugin's 131 settings and had no images at all. It now documents every schema leaf -- verified by a token audit against config_schema.json -- and shows each of the three display modes, the show_records toggle, and the card at four panel sizes. Three things the old README got wrong or left out: - The seven selection limits (recent_games_to_show and friends) are declared twice, at the config root and under game_limits, and both are read. game_limits wins where present. Same for show_records / show_ranking / show_odds under display_options, and for show_favorite_teams_only under filtering. Setting the root copy while the nested one exists looks like a setting that does nothing. - other_games_min_quality's documented choices included "broadcast", which the enum does not offer. - The scroll_settings block is unreachable (#422); the README now says so rather than describing six knobs that do nothing. mode_durations and customization.favorite_result_colors are read by the core, not by this plugin, so they look dead to a grep of this tree. The README now says where they are read. Renders come from docs/assets/nrl-scoreboard/shots.json. The fixture seeds games onto the per-mode sub-managers rather than the plugin -- every mode's display() returns early unless games_list is populated, and the live path also needs live_games -- and passes display_mode, without which the plugin's no-argument path selects nothing and draws a blank panel. The bundled PEN/MEL logo files are grey placeholders, so the crests render as blocks; the README says so. check_plugin.py passes on all eight panel sizes for all three modes. Carries the docs-tooling changes from #423 (display_mode shot key, dotted-path attrs, *_path coercion), which this render depends on. 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 |
This was referenced Sep 4, 2026
Up to standards ✅🟢 Issues
|
| Metric | Results |
|---|---|
| Complexity | 18 |
NEW Get contextual insights on your PRs based on Codacy's metrics, along with PR and Jira context, without leaving GitHub. Enable AI reviewer
TIP This summary will be updated as you push new changes.
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.
The NRL README documented roughly 55 of the plugin's 131 settings and had no images. It now covers every schema leaf — verified with a token audit against
config_schema.json— and shows each display mode, theshow_recordstoggle, and the live card at four panel sizes.Renders
All four images come from
docs/assets/nrl-scoreboard/shots.jsonand re-render with--check.Three things the fixture had to get right, all noted in the file's comment:
self._managers), not the plugin. Every mode'sdisplay()returns early unlessgames_listis populated, and the live path additionally readslive_games.display_modemust be passed. Without it the plugin's no-argument path selects nothing and draws a blank panel — this is what LEDMatrix#522 and fix(docs-tooling): let shot attrs reach nested plugin state #423 were for.home_logo_path/away_logo_pathoff the game dict asPathobjects.The bundled
PEN.png/MEL.pngare grey placeholder images, so the crests render as grey blocks. Real crests are fetched at runtime by the core's logo downloader. The README says so under each affected image rather than pretending otherwise.What the old README got wrong
game_limits, andmanager.pyreads both —game_limitswins where present. Same forshow_records/show_ranking/show_oddsunderdisplay_options, andshow_favorite_teams_onlyunderfiltering. Setting the root copy while the nested one exists presents as a setting that does nothing; the README now explains the precedence and the troubleshooting section names it.other_games_min_qualitywas documented with abroadcastchoice the enum does not offer (["any", "ranked"]).scroll_settingswas described as working. It is unreachable — filed as afl and nrl: the scroll_settings block is unreachable — the code reads scroll_mode #422 — and the README now says so rather than documenting six inert knobs.mode_durationsandcustomization.favorite_result_colorslook dead to a grep of this tree because the core reads them (src/common/sports_card.py). The README now says where they are read, so the next person does not delete them.Checks
check_plugin.py: all 8 panel sizes x 3 display modes, zero FAILadditionalPropertiesconfig_schema.jsonplugins.jsonregenerated byupdate_registry.pyDoes not touch the shared
sports.pylineage.Dependency
Carries the docs-tooling commits from #423 (the
display_modeshot key, dotted-pathattrs, and*_pathcoercion) so this branch renders standalone. Those changes are identical in both branches and will collapse on merge. The core side is ChuckBuilds/LEDMatrix#522.🤖 Generated with Claude Code