Skip to content

Clean up comments - #728

Open
lawsie wants to merge 4 commits into
flipcomputing:mainfrom
lawsie:comment-mess
Open

Clean up comments#728
lawsie wants to merge 4 commits into
flipcomputing:mainfrom
lawsie:comment-mess

Conversation

@lawsie

@lawsie lawsie commented Jul 28, 2026

Copy link
Copy Markdown
Collaborator

Summary

Claude has made a mess with verbose comments. Clean some of them up.

AI usage

Claude Opus 5 found its own mess. I validated each message change individually.

Summary by CodeRabbit

  • Accessibility

    • Improved assistive-technology announcements for rapid, repeated interaction updates so consecutive messages are reliably read out.
  • User Interface

    • Refined the color-picker’s indicator alignment by accounting for the indicator’s rendered size, keeping it correctly positioned within the color ring.
  • Documentation

    • Expanded and clarified guidance across animation behavior, error handling, model readiness, Blockly ARIA/keyboard/navigation/search/toolbox behaviors, and test-running notes.
  • Chores

    • Updated a header note in the API test runner script (no behavior changes).

@coderabbitai

coderabbitai Bot commented Jul 28, 2026

Copy link
Copy Markdown
Contributor

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: 68fb1f7d-54be-4a91-a06f-ec90b686f354

📥 Commits

Reviewing files that changed from the base of the PR and between 40149aa and 8c9883a.

📒 Files selected for processing (2)
  • flock.js
  • main/blocklyinit.js
🚧 Files skipped from review as they are similar to previous changes (2)
  • flock.js
  • main/blocklyinit.js

📝 Walkthrough

Walkthrough

This change adds alternating assertive live regions for non-deduplicated accessibility announcements, introduces color-picker indicator padding calculation, and revises comments across runtime, animation, Blockly, and API-test code. No exported API signatures change.

Changes

Accessibility and documentation refinements

Layer / File(s) Summary
Alternating assertive announcement regions
accessibility/accessibility.js
The noDedup announcement path lazily creates and alternates between two assertive live regions.
Runtime error and model-readiness documentation
flock.js
Comments clarify error collapsing, sanitization, mesh recycling, and model-readiness behavior.
Blockly validation and ARIA documentation
main/blocklyinit.js
Comments are revised around lock serialization, ARIA context, if-clause validation, and workspace revalidation.
Blockly navigation, toolbox, and search documentation
main/blocklyinit.js
Comments are updated around navigation skipping, shortcuts, search, toolbox behavior, and trashcan overlays.
UI helper and ancillary updates
ui/colourpicker.js, api/animate.js, scripts/run-api-tests.mjs
The color picker gains indicator-padding calculation; animation and API-test comments are adjusted.

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

Possibly related PRs

🚥 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 accurately summarizes the primary theme of the PR, which is mostly comment cleanup and documentation edits.
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 unit tests (beta)
  • Create PR with unit tests

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.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 4

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@flock.js`:
- Around line 216-217: Update the deduplication comment near the fault-report
handling to describe the actual signature: reports are collapsed when their key,
API, and safe.message match, regardless of values. Replace the inaccurate
“identical reports” wording and preserve the explanation that burst faults are
deduplicated within a short window.

In `@main/blocklyinit.js`:
- Around line 2454-2455: Update the comment near the search primitive override
to acknowledge that placeholder/no-match labels are localized by the wrapper,
while preserving the statement that native matching, flyout rendering, and
screen-reader announcements remain upstream; ensure it no longer claims no-match
labels stay upstream.
- Around line 378-380: Update the comment immediately above the connectingToNext
check to accurately describe only the drag-time rejection behavior, or
explicitly acknowledge that non-drag connections may still be hard-rejected by
the Rule 2 validation branch. Keep the existing behavior and
validateIfClausePositions reference unchanged.
- Around line 1334-1336: Align the comments surrounding getPrimaryEditableField
and the related navigation logic with the predicate’s actual behavior: describe
any clickable or currently editable field, including variable and dropdown
reporters, rather than limiting the scope to text-input-only fields.
Alternatively, add an explicit FieldTextInput or required-type check if the
text-input-only behavior is intended, and update both affected comment sections
consistently.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 9b520d62-5c2f-40ff-b598-45a227311614

📥 Commits

Reviewing files that changed from the base of the PR and between 82d1611 and 40149aa.

📒 Files selected for processing (6)
  • accessibility/accessibility.js
  • api/animate.js
  • flock.js
  • main/blocklyinit.js
  • scripts/run-api-tests.mjs
  • ui/colourpicker.js
💤 Files with no reviewable changes (3)
  • scripts/run-api-tests.mjs
  • ui/colourpicker.js
  • accessibility/accessibility.js

Comment thread flock.js Outdated
Comment thread main/blocklyinit.js Outdated
Comment thread main/blocklyinit.js Outdated
Comment thread main/blocklyinit.js Outdated
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