docs(soccer-scoreboard): document all 636 settings, with real renders - #436
Open
ChuckBuilds wants to merge 1 commit into
Open
docs(soccer-scoreboard): document all 636 settings, with real renders#436ChuckBuilds wants to merge 1 commit into
ChuckBuilds wants to merge 1 commit into
Conversation
The README documented six of the ten leagues by pasting a near-identical config block for each, covered a fraction of the 636 settings, and had no images. It now documents every schema leaf -- verified by a token audit -- with six renders, and keeps the ChuckBuilds links block, the supported-league table, the custom-league codes, the World Cup section, the TEAMS.md pointer and the non-favorite dwell table. Ten league blocks, 53 leaves each, identical except enabled. One <league> section collapses 477 of the 636 leaves. leagues.<slug>.display_options does nothing. Nothing in this plugin or in the core reads it; _adapt_config_for_manager takes show_records, show_ranking and show_odds from the plugin config root instead. Proved by render in both directions -- toggling the per-league copy gives byte-identical panels, toggling the root key draws and removes the records. That is 30 settings, and it is the opposite precedence to every other scoreboard here, so a config pattern carried across sets the wrong one. Filed as #435; the README documents the behaviour that exists. scroll_settings in the same blocks looks equally unreferenced but is live -- scroll_display.py delegates to the core base class, which reads it. Grepping the core is what separated the two. Soccer has the richest status model of the set, and it was undocumented beyond a list in the World Cup section: 1H, 2H, HALF, ET1, ET2, ETH and PEN while live, then Final, F/ET or F/Pen. Both now have renders. check_plugin.py passes 24/24 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
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 soccer README documented six of the ten leagues by pasting a near-identical config block for each, covered a fraction of the 636 settings, and had no images. It now documents every schema leaf — token audit: 0 undocumented — with six renders.
Kept: the ChuckBuilds links block, the supported-league table, the custom-league codes, the World Cup section, the TEAMS.md pointer, and the non-favorite dwell table.
Structure
Ten league blocks, 53 leaves each, identical except
enabled. One<league>section collapses 477 of the 636 leaves — the largest such win in this series.Soccer is also structurally unlike its siblings: three display modes in total (
soccer_live/soccer_recent/soccer_upcoming), shared across every enabled league, rather than three per league.leagues.<slug>.display_optionsdoes nothingIssue #435. Each of the ten league blocks declares
display_optionswithshow_records,show_rankingandshow_odds. Nothing reads it — zero hits in the plugin, zero in the core._adapt_config_for_managertakes all three from the plugin config root (manager.py:447-449).Proved by render in both directions: toggling the per-league copy gives byte-identical panels with no records; toggling the root key draws them and removes them.
That is 30 settings, and it is the opposite precedence to every other scoreboard in this repo, where the per-league copy wins. Anyone carrying a config pattern across from hockey or basketball will set the one that does nothing. The README documents the behaviour that exists and points at the issue.
A near-miss worth recording:
scroll_settingsin the same league blocks looked equally unreferenced — zero hits inmanager.py. It is live:scroll_display.py:128overrides_get_scroll_settings(league)and delegates to the core base class, which reads it (9 references in coresrc/). Grepping the core is what separated a real finding from a false one.Match states
Soccer has the richest status model of the six, and it was undocumented outside a bullet list in the World Cup section.
1H,2H,HALF,ET1,ET2,ETH,PENwhile live;Final,F/ET,F/Penonce over. Both groups now have their own render. Real Premier League crests.Checks
check_plugin.py: 24/24 PASS, zero FAILcustom_leagues[]item fields), 0 undocumentedadditionalProperties(leaguessetsadditionalProperties: false)config_schema.jsonplugins.jsonregeneratedDoes not touch the shared
sports.pylineage.This completes the six-scoreboard set
nrl #425, lacrosse #428, football #430, hockey #433, basketball #434, and this one — 1,600+ settings documented with 0 undocumented across all six, every one with rendered images and a passing harness.
Dependency
Carries the docs-tooling commits from #423 so this branch renders standalone; identical across all six branches and they collapse on merge.
🤖 Generated with Claude Code