Better reflect the internal mechanism inside STOP in the note.

saurtron · saurtron · commit 91bc91b73367 · 2025-04-11T14:04:57.000+02:00
diff --git a/rts/Lua/LuaConstCMD.cpp b/rts/Lua/LuaConstCMD.cpp
@@ -79,7 +79,8 @@ bool LuaConstCMD::PushEntries(lua_State* L)
 	 *
 	 * Accepts no parameters.
 	 *
-	 * *Note:* If `shift` option is used it will be a noop in the queue.
+	 * *Note:* This is actually a noop, but clears the queue when `shift` isn't used since
+	 * that's the standard behaviour when `shift` isn't used for all actions.
 	 */
 	PUSH_CMD(STOP);
 	/*** @field CMD.INSERT 1 */

Original file line number	Diff line number	Diff line change
`@@ -79,7 +79,8 @@ bool LuaConstCMD::PushEntries(lua_State* L)`
`79`	`79`	`*`
`80`	`80`	`* Accepts no parameters.`
`81`	`81`	`*`
`82`		- * Note: If `shift` option is used it will be a noop in the queue.
	`82`	+ * Note: This is actually a noop, but clears the queue when `shift` isn't used since
	`83`	+ * that's the standard behaviour when `shift` isn't used for all actions.
`83`	`84`	`*/`
`84`	`85`	`PUSH_CMD(STOP);`
`85`	`86`	`/*** @field CMD.INSERT 1 */`