]> git.sur5r.net Git - i3/i3/commitdiff
Update ipc COMMAND reply documentation
authorTony Crisci <tony@dubstepdish.com>
Fri, 28 Feb 2014 18:45:22 +0000 (13:45 -0500)
committerMichael Stapelberg <michael@stapelberg.de>
Sat, 1 Mar 2014 08:20:16 +0000 (09:20 +0100)
The COMMAND reply consists of a list of results for each command that
was parsed.

docs/ipc

index e548c074d029a3038af908c3cfbe0f09c8fa295d..2f3ea7e2c7ff23b279430962ef5a7204b03ce1e4 100644 (file)
--- a/docs/ipc
+++ b/docs/ipc
@@ -140,12 +140,13 @@ VERSION (7)::
 
 === COMMAND reply
 
-The reply consists of a single serialized map. At the moment, the only
-property is +success (bool)+, but this will be expanded in future versions.
+The reply consists of a list of serialized maps for each command that was
+parsed. Each has the property +success (bool)+ and may also include a
+human-readable error message in the property +error (string)+.
 
 *Example:*
 -------------------
-{ "success": true }
+[{ "success": true }]
 -------------------
 
 === WORKSPACES reply