Skip to content

docs(nfl-draft): document all 33 settings, with real renders - #413

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

docs(nfl-draft): document all 33 settings, with real renders#413
ChuckBuilds wants to merge 1 commit into
mainfrom
docs/nfl-draft-readme

Conversation

@ChuckBuilds

Copy link
Copy Markdown
Owner

What was missing

The configuration table covered 21 of the 33 settings. The twelve it missed include the three that decide what the panel shows once the draft is over:

  • post_draft_showfavorites, rounds or both
  • post_draft_days — how long that window lasts
  • display_rounds — how many rounds to keep showing

plus the dynamic_duration block and vegas_mode. All 33 are now documented.

vegas_mode is not dead — the core reads it

Worth recording, because the obvious check gets this wrong. Grepping this plugin for vegas_mode finds only get_vegas_content_type() and get_vegas_content(), which suggests the config key is unused. It is read by the core:

# src/plugin_system/base_plugin.py:723
config_mode = self.config.get("vegas_mode")
if config_mode:
    return VegasDisplayMode(config_mode)

It overrides the legacy get_vegas_content_type() mapping. Only olympics and this plugin declare it.

By contrast transition.type, .speed and .enabled are dead — neither the plugin nor the core reads them, and the core implements no display transitions at all. Marked as such, per #381.

Images

A pick card, the show_position and show_college toggles, two of the five offered fonts, and four panel sizes. Each pair hash-compared:

pos-on     =f72276c7bba3  pos-off  =51ab5e353780  DIFFER
pos-on     =f72276c7bba3  col-off  =fcf0f7f569ad  DIFFER
font-press =f72276c7bba3  font-4x6 =2ff0f09599c5  DIFFER

Picks are seeded onto the plugin rather than fetched — simulate_live still goes to ESPN, so it cannot drive an offline render. Two things cost me a cycle and are now recorded in the shots file:

  • draft_status: "complete" renders blank outside the post-draft window, so the fixture uses the live path.
  • The plugin normalises ESPN's fields, so a pick is pick_number / round_pick / team_abbr, not the raw overall / pick. My first fixture used the raw names and every card rendered #0 — that was my error, not the plugin's, confirmed by reading the four places the record is built.

Harness

8/8 pass, but every size warns "drew nothing". The plugin ships no test/harness.json, and the off-season guard blanks the panel, so the safety harness is checking an empty frame — nothing about the pick layout, fonts or colours is exercised. Same gap as #395 (ledmatrix-stocks); I have not filed a duplicate.

Also recorded: on first run the plugin copies its bundled nfl_draft_logo.png into the LEDMatrix assets/sports/nfl_logos/ folder, which is how the shared sports renderer finds it.

Docs only. 1.4.2 → 1.4.3.

🤖 Generated with Claude Code

@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: 301e6f1f-fa48-4d36-876f-cbcfd07a6a40


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.

The configuration table covered 21 of the 33 settings. The twelve it missed
include the three that decide what the panel shows once the draft is over --
post_draft_show, post_draft_days and display_rounds -- along with the
dynamic_duration block and vegas_mode.

vegas_mode is worth a note: grepping this plugin alone suggests it is dead,
because nothing here reads it. The core does, in
BasePlugin.get_vegas_display_mode(), where it overrides the legacy
get_vegas_content_type() mapping. Only olympics and this plugin declare it.

transition.type, .speed and .enabled are documented as doing nothing, because
neither the plugin nor the core reads them (#381).

Adds the images: a pick card, the show_position and show_college toggles, two
of the five offered fonts, and four panel sizes. Each pair was hash-compared
to confirm the setting changes the render. Picks are seeded onto the plugin
instance rather than fetched; simulate_live still goes to ESPN, so it cannot
drive an offline render.

Also records that the plugin copies its bundled logo into the LEDMatrix
assets/sports/nfl_logos folder on first run, which is how the shared sports
renderer finds it.

check_plugin.py: 8/8 pass, but every size warns "drew nothing" -- the plugin
ships no test/harness.json and the off-season guard blanks the panel, so the
harness is checking an empty frame. Same gap as #395.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@ChuckBuilds
ChuckBuilds force-pushed the docs/nfl-draft-readme branch from 18c5bc8 to 608d2cb Compare September 3, 2026 22:21
@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