From 22f8be1c5dbad28f03ba3bfb07cdf2d19ac744fb Mon Sep 17 00:00:00 2001
From: dotCooCoo <RobertLeeLW@gmail.com>
Date: Wed, 4 Nov 2026 02:37:21 -0800
Subject: [PATCH] Actions: ui.action.play's doc comment names what each
 playback speed returns

---
 crates/ui-egui/src/panels/actions.rs | 9 +++++----
 1 file changed, 5 insertions(+), 4 deletions(-)

diff --git a/crates/ui-egui/src/panels/actions.rs b/crates/ui-egui/src/panels/actions.rs
index 984ad5703..725c1aa45 100644
--- a/crates/ui-egui/src/panels/actions.rs
+++ b/crates/ui-egui/src/panels/actions.rs
@@ -553,10 +553,11 @@ pub fn action_options(app: &mut VectorcraftApp, p: &Value) -> Result<Value, Stri
 /// The command that plays an action by its name ([`play_action`]).
 pub const PLAY_ACTION: &str = "ui.action.play";
 
-/// `ui.action.play {action, set?}`: plays the action named `action` as one undoable batch, as
-/// Play Current Selection does. `set` names the set to look in (default: every set); a `set` that
-/// is not a string is an error. A name that no action has is an error, and so is a name that more
-/// than one action in the sets looked in has: then nothing plays. → what `command.batch` returns
+/// `ui.action.play {action, set?}`: plays the action named `action` at the Playback Options speed,
+/// as Play Current Selection does ([`play`]). `set` names the set to look in (default: every set); a
+/// `set` that is not a string is an error. A name that no action has is an error, and so is a name
+/// that more than one action in the sets looked in has: then nothing plays. → what [`play`] returns:
+/// at Accelerated, what `command.batch` returns; at Step by Step and Pause For, {results, pending}
 pub fn play_action(app: &mut VectorcraftApp, p: &Value) -> Result<Value, String> {
     let name = p.get("action").and_then(Value::as_str).ok_or("no such action")?;
     let in_set = match p.get("set") {