docs(masters-tournament): document all 51 settings, 17 of which do nothing - #419
Open
ChuckBuilds wants to merge 1 commit into
Open
docs(masters-tournament): document all 51 settings, 17 of which do nothing#419ChuckBuilds wants to merge 1 commit into
ChuckBuilds wants to merge 1 commit into
Conversation
…thing
Not one of the 51 settings had a named key in the README -- they were
described in prose and JSON examples, so there was no path to copy into
config.json for any of them. All 51 are now documented at the paths the schema
expects.
Seventeen of them have no effect. Counting reads of each top-level block
across the plugin's Python:
display_modes 9 reads 29 leaves
notifications 0 reads 8 leaves
branding 0 reads 4 leaves
Neither config.get("notifications") nor config.get("branding") appears
anywhere in the plugin, and neither is read by the core -- yet the README had
sections for both, describing alerts that interrupt the display and toggles
for the Masters logo, the green jacket, the azaleas and a colour scheme. Five
more leaves inside display_modes are unread: player_cards.show_headshots and
.duration_per_player, and course_tour.show_animations, .duration_per_hole and
.featured_holes. Filed as #418; nothing removed from the schema.
Two that look dead and are not, both checked before assuming:
display_modes.<mode>.enabled is read generically through a key built from the
mode name, and the six source hits for featured_holes are all the display mode
masters_featured_holes rather than the config key of that name.
Images: all fourteen display modes, rendered with the plugin's own mock_data
mode so they need no network. They are split by tournament phase because
enabling a mode is not enough on its own -- eight render only during Masters
week and six only outside it, and the other set comes out blank. That is the
phase gate working, which the README now says.
check_plugin.py: 80/80 pass, no failures.
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.
Not one setting had a named key
All 51 were described in prose and JSON examples — there was no path you could copy into
config.jsonfor any of them. All 51 are now documented at the paths the schema expects.Seventeen of them have no effect
Counting reads of each top-level block across the plugin's Python:
Neither
config.get("notifications")norconfig.get("branding")appears anywhere in the plugin, and neither is read by the core. The README had sections for both — describing alerts that interrupt the display, and toggles for the Masters logo, the green jacket, the azaleas and a colour scheme.Five more leaves inside
display_modesare unread despite that block being live:player_cards.show_headshots,player_cards.duration_per_player,course_tour.show_animations,course_tour.duration_per_hole,course_tour.featured_holes.Filed as #418. I have marked them in the README and changed nothing in the schema — whether these were abandoned or unfinished is your call.
Two that look dead and are not
Both checked before assuming, after
cricket-scoreboard(#416) turned out to readmode_durationsthrough a runtime-built key:display_modes.<mode>.enablednever appears as a literal for most modes. It is read generically viaconfig_key_map, so every mode'senabledis live.featured_holeshas six source hits — every one is the display modemasters_featured_holes, not thecourse_tour.featured_holesconfig key. That key really is dead.Images: all fourteen modes
Rendered with the plugin's own
mock_datamode, so they need no network at all — the cleanest fixture of any plugin so far.They are split into two sheets because enabling a mode is not sufficient on its own: eight render only during Masters week, six only outside it, and the other set comes out blank. I confirmed this by rendering the six blank ones again with the clock moved to January, where all six render fine — so it is the phase gate working as designed, not a fault. The README now says so, since "I enabled it and got nothing" is otherwise a reasonable bug report.
One observation I am not filing: on a 128-wide panel Amen Corner packs three hole names against their par and yardage and the two columns sit very close. I could not measure a definite overlap, so the README notes the tightness rather than claiming a defect.
Checks
check_plugin.py: 80/80 pass, no failuresrender_docs_assets.py --check: all four images reproduceDocs only. 2.5.5 → 2.5.6.
🤖 Generated with Claude Code