docs(basketball-scoreboard): document all 274 settings, with real renders - #434
Open
ChuckBuilds wants to merge 1 commit into
Open
docs(basketball-scoreboard): document all 274 settings, with real renders#434ChuckBuilds wants to merge 1 commit into
ChuckBuilds wants to merge 1 commit into
Conversation
…ders The README covered a fraction of the 274 settings and had no images. It now documents every schema leaf -- verified by a token audit -- with five renders, and keeps the ChuckBuilds links block, the four team abbreviation lists, the background-service notes, the NCAA season-data caveat, the game-limits behaviour and the non-favorite dwell table. Four leagues. Only two defaults differ across them -- enabled, and show_ranking, which is on for the two college leagues -- so that is a short table plus one <league> section rather than 200 duplicated rows. The two NCAA blocks carry a march_madness section the NBA and WNBA do not have: seeds in place of AP rankings, the round abbreviation, the bracket region, a tournament-game cap, and a tournament_mode override that is otherwise decided from the calendar. It now has its own section and a three-way render. Also newly documented: - The mode toggles are show_live / show_recent / show_upcoming here, as in football, not live / recent / upcoming as in hockey and lacrosse. A display_modes block copied across silently sets nothing. - mode_durations has no live_mode_duration in this plugin, unlike the football, hockey and lacrosse scoreboards. - other_games_min_quality is live for the college leagues, which have a poll, and inert for the NBA and WNBA, which do not. 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
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 basketball README covered a fraction of the 274 settings and had no images. It now documents every schema leaf — token audit: 0 undocumented — with five renders.
Kept: the ChuckBuilds links block, all four team-abbreviation lists, the background-service notes, the NCAA season-data caveat, the game-limits behaviour, and the non-favorite dwell table.
Structure
Four leagues, and unusually little divergence — only
enabledanddisplay_options.show_rankingdiffer (rankings default on for the two college leagues). So the per-league material is one<league>section plus a two-row table, instead of ~200 duplicated rows.The running count of per-league default divergences across this series: lacrosse 1, football 5, hockey 9, basketball 2. Worth diffing programmatically every time rather than assuming.
March Madness
The two NCAA blocks carry a
march_madnesssection the NBA and WNBA blocks do not have — five settings that were entirely undocumented.tournament_modeis the interesting one: left unset the plugin decides from the calendar (_is_march_madness_window), and setting it explicitly overrides that in both directions.One thing I got wrong first and corrected: I rendered the tournament shots on the recent card and the round never appeared. Reading
sports.py:2433showed why — the round and region replace the "Next Game" header, so they only draw on the Upcoming card; seeds draw wherever records would, on any tournament card. The fixture and the README both say so now.Also newly documented
show_live/show_recent/show_upcominghere, as in football — notlive/recent/upcomingas in hockey and lacrosse. Adisplay_modesblock copied across silently sets nothing.mode_durationshas nolive_mode_durationin this plugin, unlike football, hockey and lacrosse. Live mode's total comes from dynamic duration or the per-game duration instead.other_games_min_qualityis live for the two college leagues, which have a national poll, and inert for the NBA and WNBA.other_games_divisionsis inert in all four.I checked
game_renderer.pyfor the key-split bug found in hockey (#432) — basketball's copy has noself.config.get(league, ...)lookup, so it is not affected.Checks
check_plugin.py: 24/24 PASS, zero FAILadditionalPropertiesconfig_schema.jsonplugins.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