Update ipc COMMAND reply documentation
Patch status: merged
Patch by Tony Crisci
Long description:
The COMMAND reply consists of a list of results for each command that was parsed.
To apply this patch, use:
curl http://cr.i3wm.org/patch/437/raw.patch | git am
b/docs/ipc
| 15 |
@@ -140,12 +140,13 @@ VERSION (7):: |
| 16 |
|
| 17 |
=== COMMAND reply |
| 18 |
|
| 19 |
-The reply consists of a single serialized map. At the moment, the only |
| 20 |
-property is +success (bool)+, but this will be expanded in future versions. |
| 21 |
+The reply consists of a list of serialized maps for each command that was |
| 22 |
+parsed. Each has the property +success (bool)+ and may also include a |
| 23 |
+human-readable error message in the property +error (string)+. |
| 24 |
|
| 25 |
*Example:* |
| 26 |
------------------- |
| 27 |
-{ "success": true }
|
| 28 |
+[{ "success": true }]
|
| 29 |
------------------- |
| 30 |
|
| 31 |
=== WORKSPACES reply |