Skip to content

docs(cua-driver): update delivery_mode wording in comments - #2092

Merged
f-trycua merged 3 commits into
trycua:mainfrom
injaneity:docs/replace-stale-dispatch-comments
Jul 26, 2026
Merged

docs(cua-driver): update delivery_mode wording in comments#2092
f-trycua merged 3 commits into
trycua:mainfrom
injaneity:docs/replace-stale-dispatch-comments

Conversation

@injaneity

@injaneity injaneity commented Jul 1, 2026

Copy link
Copy Markdown
Collaborator

Updates stale dispatch:"foreground" / dispatch:"background" references in Rust comments, test descriptions, and the macOS bring_to_front tool description to use the 0.7.0 delivery_mode terminology. No behavior changes.

Summary by CodeRabbit

  • Documentation
    • Updated input-routing terminology in test notes and platform docs to consistently use “delivery mode” instead of “dispatch mode.”
    • Clarified foreground and background behavior wording across Windows, macOS, and UI test references.
    • No functional behavior, test logic, or public APIs changed.

@vercel

vercel Bot commented Jul 1, 2026

Copy link
Copy Markdown
Contributor

@injaneity is attempting to deploy a commit to the Cua Team on Vercel.

A member of the Team first needs to authorize it.

@coderabbitai

coderabbitai Bot commented Jul 1, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 515f104b-6aec-4f1a-9cf7-0fc08cd02f46

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
📝 Walkthrough

Walkthrough

This PR renames the terminology "dispatch" to "delivery_mode" across comments, doc comments, and assertion messages in Rust test files (harness_winui3_test.rs, harness_wpf_test.rs, modality_input_e2e_test.rs) and platform crate source files (bring_to_front.rs, delivery.rs, uia/mod.rs). No executable logic or public APIs are changed.

Changes

Terminology Update

Layer / File(s) Summary
Test comment updates
libs/cua-driver/rust/crates/cua-driver/tests/harness_winui3_test.rs, harness_wpf_test.rs, modality_input_e2e_test.rs
Comments and assertion failure messages across regression-guard, caveat, and rationale text are updated from dispatch:"..." to delivery_mode:"..." phrasing.
Platform crate doc updates
libs/cua-driver/rust/crates/platform-macos/src/tools/bring_to_front.rs, libs/cua-driver/rust/crates/platform-windows/src/input/delivery.rs, libs/cua-driver/rust/crates/platform-windows/src/uia/mod.rs
Module-level docs, a ToolDef description string, and diagnostic/fallback comments are updated to use delivery_mode:"..." instead of dispatch:"...".

Estimated code review effort: 1 (Trivial) | ~3 minutes

Possibly related PRs

  • trycua/cua#2077: Performed the same "dispatch" to "delivery_mode" rewording across related Cua Driver Windows/UIA dispatch-related comments and docs.

Poem

A word once said "dispatch" with pride,
now "delivery_mode" rides beside.
No logic bent, no tests to fret—
just cleaner words this rabbit set. 🐇
Hop along, the comments gleam anew!

🚥 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 comment-only docs update to replace stale dispatch wording with delivery_mode terminology.
Docstring Coverage ✅ Passed Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.
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.

@f-trycua

f-trycua commented Jul 1, 2026

Copy link
Copy Markdown
Collaborator

Thanks — this is a clean comment/description-only rename to the 0.7.0 delivery_mode wording, and it's accurate. One blocker: the bring_to_front tool description edit feeds the docs generator, so mcp-tools.mdx is now out of sync and the required Documentation Sync check fails.

Please regenerate with npx tsx scripts/docs-generators/cua-driver.ts and commit the updated mcp-tools.mdx — then it's a trivial merge.

@f-trycua f-trycua added the no-release Skip auto-release on merge label Jul 26, 2026
# Conflicts:
#	docs/content/docs/reference/cua-driver/mcp-tools.mdx
#	libs/cua-driver/rust/crates/cua-driver/tests/harness_wpf_test.rs
#	libs/cua-driver/rust/crates/cua-driver/tests/modality_input_e2e_test.rs

@f-trycua f-trycua left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Reviewed at updated head cba1514. The conflict resolution retains current-main test behavior, keeps the obsolete deleted test deleted, changes only stale delivery_mode terminology, generated docs are in sync, no-release is present, and the full CI matrix passes.

@f-trycua
f-trycua merged commit e464569 into trycua:main Jul 26, 2026
22 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

no-release Skip auto-release on merge

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants