Skip to content

WINCTRL CDU Reverse video support#435

Open
ColinM9991 wants to merge 1 commit intoneilenns-projects:mainfrom
ColinM9991:inverse-video-support
Open

WINCTRL CDU Reverse video support#435
ColinM9991 wants to merge 1 commit intoneilenns-projects:mainfrom
ColinM9991:inverse-video-support

Conversation

@ColinM9991
Copy link
Copy Markdown
Contributor

@ColinM9991 ColinM9991 commented Mar 14, 2026

Adds documentation for the new backwards compatible schema which supports reverse-video functionality for WINWING CDUs

This also corrects an incorrect colour. o represents blue rather than brown

Dependency: MobiFlight/MobiFlight-Connector#2742

Summary by CodeRabbit

  • Documentation
    • Updated developer documentation to reflect enhancements to the data structure, now supporting an optional style parameter that enables both normal and inverse display modes for improved flexibility.
    • Revised color identifier mapping to provide better visual consistency across the application.

@ColinM9991 ColinM9991 requested a review from neilenns as a code owner March 14, 2026 17:35
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Mar 14, 2026

📝 Walkthrough

Walkthrough

The pull request updates documentation describing a game controller CDU (Control Display Unit) data structure. It documents adding a fourth element ("style") to array entries and corrects a color mapping, changing code "o" from brown to blue.

Changes

Cohort / File(s) Summary
Documentation Update
content/game-controllers/winctrl/winctrl-cdu/dev-instructions/index.md
Extended data structure definition from triplet to quadruplet format, introducing optional "style" field (0 for normal, 1 for inverse). Updated color mapping for code "o" from brown to blue.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~4 minutes

Suggested labels

documentation

Suggested reviewers

  • neilenns

Poem

🐰 A hop, skip, and a style so fine,
Data structures now with quadruplet design,
From brown to blue, the colors dance,
Controller wisdom in each advance!
Documentation hops along with glee, 🎮✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title 'WINCTRL CDU Reverse video support' directly relates to the main change: adding reverse-video functionality support to the schema and documentation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
📝 Coding Plan
  • Generate coding plan for human review comments

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 and usage tips.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 Nitpick comments (1)
content/game-controllers/winctrl/winctrl-cdu/dev-instructions/index.md (1)

30-35: Add one explicit 4-item example for the new style field.

Line 30 and Line 34 correctly document backward-compatible quadruplets, but the page still only shows 3-item array examples. Consider adding a concrete inverse-style example to make adoption clearer.

✍️ Suggested doc tweak
 - Each list element is a quadruplet.
   1. The character to be shown as UTF-8 string.
   2. The color as UTF-8 string.
   3. The size as a number (0 large, 1 small).
   4. The style denoting reverse video/inverted text (0 normal, 1 inverse) (Optional: defaults to 0).
+  - Example with inverse style: `["A", "w", 0, 1]`.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@content/game-controllers/winctrl/winctrl-cdu/dev-instructions/index.md`
around lines 30 - 35, Add an explicit 4-item example demonstrating the new style
field (inverse/reverse video) where the array contains: the character, the
color, the size, and the style value set to 1 to indicate inverse; replace or
augment one of the existing 3-item examples so readers see the
backward-compatible quadruplet format in practice (keep the existing SPACE
empty-element example unchanged). Locate the example arrays described in the
list that explains the quadruplet format and insert the four-item example
alongside the current examples to clearly show the fourth field usage.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@content/game-controllers/winctrl/winctrl-cdu/dev-instructions/index.md`:
- Around line 30-35: Add an explicit 4-item example demonstrating the new style
field (inverse/reverse video) where the array contains: the character, the
color, the size, and the style value set to 1 to indicate inverse; replace or
augment one of the existing 3-item examples so readers see the
backward-compatible quadruplet format in practice (keep the existing SPACE
empty-element example unchanged). Locate the example arrays described in the
list that explains the quadruplet format and insert the four-item example
alongside the current examples to clearly show the fourth field usage.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yml

Review profile: CHILL

Plan: Pro

Run ID: 51a0d816-eeda-4aba-9e8c-75f2adb46aef

📥 Commits

Reviewing files that changed from the base of the PR and between 2be71d3 and e21dfa4.

📒 Files selected for processing (1)
  • content/game-controllers/winctrl/winctrl-cdu/dev-instructions/index.md

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