docs(hockey-scoreboard): document all 226 settings, with real renders - #433
Open
ChuckBuilds wants to merge 1 commit into
Open
docs(hockey-scoreboard): document all 226 settings, with real renders#433ChuckBuilds wants to merge 1 commit into
ChuckBuilds wants to merge 1 commit into
Conversation
The README ran to 894 lines and still covered a fraction of the 226 settings, with no images. It now documents every schema leaf -- verified by a token audit -- with five renders, and keeps the ChuckBuilds links block, the rotation and resume semantics, the non-favorite dwell table, the exclude-teams note and all three example configurations. Three leagues, 53 leaves each. The two NCAA blocks are identical; the NHL block differs in nine defaults, so that is a table rather than 106 duplicated rows. Two settings do not work, and the README now says so rather than describing them as features: - show_powerplay is resolved into the manager config and power_play is extracted onto the game dict, but nothing in this plugin or in the core draws either. No value changes the render. Filed as #431. - Scroll and Vegas cards gate the shot line on a flat show_shots key at the league root, which the schema never declares, so it reads False whatever show_shots_on_goal is set to. Switch mode is unaffected. Filed as #432. Also documented: the per-league display_options copy wins over the defaults copy and several of its defaults differ -- show_shots_on_goal is false under defaults and true under nhl -- which presents as a setting that does nothing. check_plugin.py passes with no FAIL. Carries the docs-tooling changes from #423, 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 |
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
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.
The hockey README ran to 894 lines and still covered a fraction of the 226 settings, with no images. It now documents every schema leaf — token audit: 0 undocumented — with five renders.
Kept: the ChuckBuilds links block, rotation and resume semantics, the non-favorite dwell table, the exclude-teams note, and all three example configurations.
Structure
Three leagues, 53 leaves each. The two NCAA blocks are identical to each other; the NHL block differs in nine defaults —
enabled,live_priority,display_durations.live, bothupdate_intervals, and four of the fivedisplay_options. Documented as a nine-row comparison plus one<league>table, rather than 106 duplicated rows.Two settings that do not work
#431 —
show_powerplaydraws nothing. ESPN'sisPowerPlayis read (hockey.py:83), stored aspower_play(hockey.py:109), and the setting is resolved into the manager config (manager.py:825,:849). Nothing consumes either. I grepped the core as well:src/base_classes/hockey.py:116andsrc/base_classes/api_extractors.py:308also only producepower_play. No value of the setting changes the render — which is why there is deliberately no power-play image in this PR, and the fixture comment says so.#432 — shots never show on scroll or Vegas cards. The switch card reads the resolved
show_shots_on_goal;game_renderer.py:651reads a flatshow_shotsat the league root, which the schema declares nowhere, so it is alwaysFalse. Two resolution points for one feature.Renders
Five images from
docs/assets/hockey-scoreboard/shots.json: hero, the three display modes, the three period states (P2/Final/Final/OT),show_shots_on_goalon and off,show_recordson and off, and four panel sizes. Real NHL crests.Also documented
The per-league
display_optionscopy wins over thedefaultscopy and several of its defaults differ —show_shots_on_goalisfalseunderdefaultsandtrueundernhl,show_recordsandshow_rankinginvert between NHL and NCAA. Changing thedefaultscopy on a UI-written config appears to do nothing. That is the same trap as #427 and #429, now called out in both the settings reference and troubleshooting.nhl.filtering.other_games_min_qualitystill carries the stalebroadcasttext covered by #426; the README notes it was retired.Checks
check_plugin.py: zero FAILadditionalPropertiesconfig_schema.json, including all nine per-league divergencesplugins.jsonregeneratedDoes not touch the shared
sports.pylineage.Dependency
Carries the docs-tooling commits from #423 so this branch renders standalone; identical in both branches and they collapse on merge.
🤖 Generated with Claude Code