Skip to content

fix: exclude SFX from lettering order - #17

Merged
wenn-id merged 2 commits into
mainfrom
fix/sfx-lettering-reading-order
Jul 31, 2026
Merged

fix: exclude SFX from lettering order#17
wenn-id merged 2 commits into
mainfrom
fix/sfx-lettering-reading-order

Conversation

@wenn-id

@wenn-id wenn-id commented Jul 31, 2026

Copy link
Copy Markdown
Owner

Summary

  • enumerate only dialogue and caption placements after SFX filtering
  • preserve authored priority, validation, counts, and byte-identical mixed-SFX rendering
  • add a regression for SFX priority 1 followed by rendered text
  • document the approved design and TDD implementation plan

TDD evidence

  • RED: expected [1, 2], engine returned [2, 3]
  • GREEN: focused lettering contracts 4/4 pass

Validation

  • full suite: 343 passed, 1 skipped
  • compileall: pass
  • wheel/sdist build and release validation: pass
  • clean install base and MCP: pass
  • doctor: pass
  • diff hygiene: pass

Merge ownership

CodeRabbit is requested to review and merge this PR after all required checks pass. The authoring agent will not merge it.

Summary by CodeRabbit

  • Bug Fixes
    • Sound effects no longer consume reading-order numbers when lettering dialogue and captions.
    • Dialogue and caption placements now retain consecutive numbering, regardless of preceding sound effects.
    • Sound effects continue to be included in validation and text statistics while producing no lettering placement.

@coderabbitai

coderabbitai Bot commented Jul 31, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: bf57de98-fad0-455b-ba99-eaa3ed12c943

📥 Commits

Reviewing files that changed from the base of the PR and between 38a14c8 and 586b58b.

📒 Files selected for processing (4)
  • docs/superpowers/plans/2026-07-31-sfx-lettering-reading-order-implementation.md
  • docs/superpowers/specs/2026-07-31-sfx-lettering-reading-order-design.md
  • scripts/letter_panels.py
  • tests/test_lettering.py

📝 Walkthrough

Walkthrough

The lettering renderer now excludes SFX items from placement generation and reading-order numbering. Authored ordering, validation, and text counts remain unchanged. Design and implementation plans document the behavior, and a regression test covers dialogue and caption ordering.

Changes

SFX lettering behavior

Layer / File(s) Summary
Reading-order contract
docs/superpowers/specs/2026-07-31-sfx-lettering-reading-order-design.md, docs/superpowers/plans/2026-07-31-sfx-lettering-reading-order-implementation.md
The design and implementation plan define separate authored and renderable sequences. SFX remains in validation and counts but does not receive a placement.
Renderable placement flow
scripts/letter_panels.py, tests/test_lettering.py
letter_panel filters SFX before counting and processing renderable items. The regression test verifies consecutive dialogue and caption reading orders.

Estimated code review effort: 2 (Simple) | ~10 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely describes the main change: excluding SFX entries from lettering order.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix/sfx-lettering-reading-order

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

@wenn-id

wenn-id commented Jul 31, 2026

Copy link
Copy Markdown
Owner Author

@coderabbitai help

@coderabbitai

coderabbitai Bot commented Jul 31, 2026

Copy link
Copy Markdown

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

CodeRabbit commands

These commands are invoked using PR/Issue comments.

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai rate limit to show your current review rate limit status.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai evaluate custom pre-merge check --instructions <custom-checks-instructions> --name <custom-checks-title> [--mode <error|warning>] to validate the custom pre-merge checks instructions. Defaults to error when --mode is omitted.
  • @coderabbitai ignore pre-merge checks to override pre-merge checks and get an approval on PR.
  • @coderabbitai run pre-merge checks to run pre-merge checks on the pull request.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai generate unit tests to generate unit tests for this PR.
  • @coderabbitai emit path instructions to emit generated path-specific review instructions for this repository.
  • @coderabbitai resolve merge conflict to automatically resolve merge conflicts.
  • @coderabbitai autofix to automatically fix issues identified in unresolved review comments.
  • @coderabbitai fix-ci to automatically fix failing CI checks by creating a stacked PR with fixes.
  • @coderabbitai resolve to resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai generate configuration to create a PR that adds the current resolved configuration as .coderabbit.yaml (or show it if already present).
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore or @coderabbit ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit configuration file (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • You can also validate your configuration using the online YAML validator.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Status, support, documentation and community

  • Visit our status page to check the current availability of CodeRabbit.
  • Create a ticket on our support page for assistance with any issues or questions.
  • Visit our documentation site for detailed information on how to use CodeRabbit.
  • Join our Discord community to connect with other users and get help from the community.
  • Follow us on X/Twitter for updates and announcements.

@wenn-id
wenn-id merged commit f46bcfa into main Jul 31, 2026
8 checks passed
@wenn-id
wenn-id deleted the fix/sfx-lettering-reading-order branch July 31, 2026 04:28
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