Skip to content

docs(f1-scoreboard): fill the last five settings, and mark three that do nothing - #421

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

docs(f1-scoreboard): fill the last five settings, and mark three that do nothing#421
ChuckBuilds wants to merge 1 commit into
mainfrom
docs/f1-readme

Conversation

@ChuckBuilds

Copy link
Copy Markdown
Owner

This one was already close

The most complete scoreboard README so far — 65 of 70 settings documented, including all eight display modes, the Vegas marquee and the timezone handling. The five missing were customization.auto_scale and the four per-role font sizes, which sat in the same section as the fonts they scale without being named. Now covered.

Three settings do nothing

upcoming.show_session_times, upcoming.countdown_enabled and qualifying.show_gaps appear nowhere in the plugin and nowhere in the core. The countdown that countdown_enabled claims to gate is drawn regardless, so turning it off changes nothing — the README said "Live countdown to next session" as though it were a switch.

Marked in place; schema untouched.

Two that look dead and are not

Both checked before assuming, which is now the third time this pattern has appeared:

qualifying.show_q1, show_q2 and show_q3 never appear as .get() arguments. They are string literals in a tuple table the loop reads through:

for session_key, show_key, label in [
    ("q3", "show_q3", "Q3"),
    ("q2", "show_q2", "Q2"),
    ("q1", "show_q1", "Q1"),
]:
    if not quali_config.get(show_key, True):
        continue

Same runtime-key shape as cricket's mode_durations (#416) and masters' display_modes.<mode>.enabled (#418). A plain config-access grep calls all three dead.

Images

Both standings modes, the constructor show_driver_split toggle, and four panel sizes. Each card is tinted with the team's colour and the header carries a season progress bar.

The other six modes are not pictured — recent races, upcoming, qualifying, practice, sprint and calendar all need a live race weekend to have anything to show. The README says so, rather than leaving them silently unillustrated.

Standings are seeded onto the plugin; _last_update has to be seeded too or update() re-fetches and clears them.

Checks

  • check_plugin.py: 48/48 pass, zero failures, across all eight modes
  • render_docs_assets.py --check: all four images reproduce
  • config-token audit: nothing dropped

Docs only. 1.8.6 → 1.8.7.

🤖 Generated with Claude Code

… do nothing

This README was already the most complete of the scoreboards: 65 of the 70
settings were documented, including all eight display modes and the Vegas
marquee. The five missing were customization.auto_scale and the four per-role
font sizes, which sat alongside the fonts they scale without being named.

Three settings do nothing. upcoming.show_session_times,
upcoming.countdown_enabled and qualifying.show_gaps appear nowhere in the
plugin and nowhere in the core. The countdown that countdown_enabled claims to
gate is drawn regardless, so turning it off changes nothing. Marked in place;
schema untouched.

Two that look dead and are not, both checked before assuming: show_q1, show_q2
and show_q3 never appear as .get() arguments -- they are string literals in a
tuple table that the loop reads through, the same runtime-key pattern as
cricket's mode_durations (#416) and masters' display_modes (#418).

Adds real rendered screenshots of both standings modes, the constructor
show_driver_split toggle and four panel sizes. Standings are seeded onto the
plugin instance; _last_update has to be seeded too or update() re-fetches and
clears them. The other six modes -- recent races, upcoming, qualifying,
practice, sprint and calendar -- need a live race weekend to have anything to
show, which the README now says rather than leaving them unillustrated without
explanation.

check_plugin.py: 48/48 pass across all eight modes.

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

coderabbitai Bot commented Sep 4, 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: d64dfa73-1460-47a7-b723-33dc50707016


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