From: Tony Crisci <tony@dubstepdish.com>
Date: Fri, 28 Feb 2014 18:45:22 +0000 (-0500)
Subject: Update ipc COMMAND reply documentation
X-Git-Tag: 4.8~108
X-Git-Url: https://git.sur5r.net/?a=commitdiff_plain;h=d5cf494ba26d6dffde002907d620736e6c71adf7;p=i3%2Fi3

Update ipc COMMAND reply documentation

The COMMAND reply consists of a list of results for each command that
was parsed.
---

diff --git a/docs/ipc b/docs/ipc
index e548c074..2f3ea7e2 100644
--- 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