Skip to content

docs(olympics): document all 25 settings, and record two live defects - #411

Open
ChuckBuilds wants to merge 1 commit into
mainfrom
docs/olympics-readme
Open

docs(olympics): document all 25 settings, and record two live defects#411
ChuckBuilds wants to merge 1 commit into
mainfrom
docs/olympics-readme

Conversation

@ChuckBuilds

Copy link
Copy Markdown
Owner

The configuration section was mostly wrong

It listed 7 of the 25 settings, and four of those seven were incorrect:

README said Reality
display_duration default 15 schema says 30
update_interval default 3600 schema says 300
logo_size (8–64) not in the schema at all
a Transitions section documenting transition.type / .speed / .enabled nothing in the plugin reads them

The logo_size one bites twice. The schema sets additionalProperties: false, so the README's own example configuration — which includes logo_size — is rejected, not ignored. A troubleshooting line also advised reducing it when text does not fit.

Meanwhile the eighteen settings that actually work were undocumented, including every one that decides what appears on screen: show_medals, show_schedule, show_results, medal_race_enabled, live_alerts_enabled, top_countries_count, rival_countries, sport_filters, vegas_mode, and the whole notification block.

All 25 are now documented and grouped, with the four dead ones (transition.* plus high_performance_transitions, per #381) in a section that says plainly that they do nothing.

Two live defects, filed as #410

The countdown is negative right now. The plugin carries a single hardcoded Games:

CURRENT_OLYMPICS = {'name': 'Milano Cortina 2026', 'opening': datetime(2026, 2, 6), ...}

and _calculate_days_until returns (target - today).days with no floor and nothing to roll forward to. Since those Games closed it has rendered -209 DAYS UNTIL WINTER OLYMPICS. The README claimed dates for 2028, 2030 and 2032 are included — grepping the plugin for those years returns nothing.

DAYS UNTIL is clipped below 256px, because the lines are centred in the right half of the panel and the label is wider than that half. 64x32 loses most of it and overlaps the rings.

I initially assumed this was a silent draw-time clip like the ones in web-ui-info and ledmatrix-weather. It is not — check_plugin.py fails six of its eight sizes on it, and the two that pass are exactly the 256-wide ones:

[FAIL]   64x32  olympics overflow bbox=(64, 8, 87, 31)
[FAIL]  128x32  olympics overflow bbox=(129, 8, 135, 15)
[FAIL]   64x64  olympics overflow bbox=(64, 16, 87, 55)
[FAIL]   96x48  olympics overflow bbox=(96, 12, 111, 43)
[FAIL]  128x64  olympics overflow bbox=(129, 16, 135, 23)
[PASS]  256x32  olympics
[FAIL]  128x96  olympics overflow bbox=(129, 24, 135, 31)
[PASS] 256x128  olympics

Reproduced on a clean tree with no local changes, so this plugin is currently failing its own safety harness on main. I corrected the issue text after finding this — my first write-up said the harness passed.

What I did not do

No code changed. Fixing the negative countdown needs a decision I did not want to take unilaterally — add the future Games and roll forward, or clamp and show "games over" — and the clipping needs layout work across eight sizes. Both are described in #410 with the evidence.

The screenshots show the current behaviour, including the clipped DAYS UNTI, rather than a panel size where it happens to fit.

Docs only. 2.0.1 → 2.0.2.

🤖 Generated with Claude Code

The configuration section listed 7 of the 25 settings, and four of the seven
were wrong:

- display_duration was given as 15; the schema default is 30.
- update_interval was given as 3600; the schema default is 300.
- logo_size does not exist in the schema. Because the schema sets
  additionalProperties: false, the README's own example configuration -- which
  includes it -- is rejected rather than ignored. A troubleshooting line also
  told people to reduce it when text does not fit.
- The whole "Transitions" section documented transition.type, .speed and
  .enabled as working. Nothing in the plugin reads them, and neither does
  high_performance_transitions (#381).

Meanwhile the eighteen settings that do work were undocumented, including
every one that decides what appears: show_medals, show_schedule, show_results,
medal_race_enabled, top_countries_count, rival_countries, sport_filters,
vegas_mode and the notification block.

All 25 are now covered, grouped, with the four dead ones marked as such.

Also records two defects on the countdown screen, filed as #410:

The day count has been negative since February 2026. The plugin carries one
hardcoded Games -- Milano Cortina, opening 2026-02-06 -- and _calculate_days_until
returns a plain difference with no floor and nothing to roll on to, so it now
renders "-209 DAYS UNTIL WINTER OLYMPICS". The README had claimed dates for
2028, 2030 and 2032 are included; grepping the plugin for those years returns
nothing.

"DAYS UNTIL" is clipped on every panel narrower than 256, because the lines are
centred in the right half and the label is wider than that half. This one is
not silent: check_plugin.py fails six of its eight sizes on it, reproduced on a
clean tree, so the plugin is currently failing its own harness on main.

No code changed here; the screenshots show the current behaviour rather than a
size where it happens to look right.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Sep 3, 2026

Copy link
Copy Markdown
Contributor

Important

  • 🔍 Trigger review

This repository does not receive automatic reviews because it has fewer than 10 stars.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Team

Run ID: eb6b1493-03f4-4380-bc30-e9b84e87a368


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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@codacy-production

Copy link
Copy Markdown

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant