docs(afl-scoreboard): document the settings the rewrite dropped - #361
Merged
Conversation
Auditing my own baseball rewrite turned up the same failure mode in the AFL one that already merged: reorganising the README lost content. Comparing every config token the old file mentioned against the new one found two settings gone entirely, plus a framing error. other_games_min_quality and other_games_divisions were not documented at all. Both are now, together with the fact that neither does anything in this league: 'ranked' needs a national poll the AFL does not publish, so the filter passes every game and no poll is requested; the divisions filter needs ESPN's FBS/FCS group rosters, which exist for college football and nothing else. Also records that favourites are never filtered by either, and that both fail open. The framing error is worth more than the omissions. upcoming_games_to_show is a pool the panel cycles through one card at a time, keeping its place between visits -- so raising it lengthens the lap and any one game comes round LESS often. The README implied the opposite, which would send someone tuning it in exactly the wrong direction. Also restores the debug-logging tip for finding an unfamiliar team abbreviation, and a manual-installation section. 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.
Follow-up to #358, which merged. Self-audit found a problem with my own work.
While writing the baseball README I noticed my rewrites were reorganising well but losing content. So I diffed every config token the old READMEs mentioned against the new ones. AFL had two settings gone entirely, plus a framing error that's worse than the omissions.
The framing error
upcoming_games_to_showis a pool the panel cycles through one card at a time, keeping its place between visits. Raising it lengthens the lap, so any one game comes round less often — not more.My README implied the opposite. Someone wanting to see their team more would have turned it up and got the reverse. Corrected here, and in #360 for baseball.
The two missing settings
other_games_min_quality(defaultranked) andother_games_divisions(default["fbs"]) weren't documented at all. Both are now — including that neither does anything in this league:rankedneeds a national poll. The AFL publishes none, so the filter passes every game and no poll is requested.Also recorded: favourites are never filtered by either setting, and both fail open — including as a set, so the filters can't leave the board empty by accident.
Plus the debug-logging tip for finding an unfamiliar team abbreviation, and a manual-installation section.
On the audit itself
The check is mechanical and I'll run it on every remaining plugin before opening its PR:
Run against the merged 7-segment-clock README it flags only
display_managerandupdate_interval, both of which my version covers in substance rather than by name — no action needed there.Manifest bumped 1.19.2 → 1.19.3,
plugins.jsonregenerated.🤖 Generated with Claude Code