summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMichael Stapelberg <michael@stapelberg.de>2020-11-03 09:48:28 +0100
committerMichael Stapelberg <michael@stapelberg.de>2020-11-03 09:48:28 +0100
commitc22b35c293ad8c473e7c802117dba97c98141382 (patch)
treedd1ddd1747c558145e52ee41ecdb47a38886bcaa
parent19fbe1d30c67cfe6e257a04edeb3a63d521992ca (diff)
downloadi3-c22b35c293ad8c473e7c802117dba97c98141382.tar.gz
i3-c22b35c293ad8c473e7c802117dba97c98141382.zip
ipc: document parse_error COMMAND reply field
fixes #4166
-rw-r--r--docs/ipc8
1 files changed, 8 insertions, 0 deletions
diff --git a/docs/ipc b/docs/ipc
index 62f6555c..bb8719cb 100644
--- a/docs/ipc
+++ b/docs/ipc
@@ -161,6 +161,14 @@ sending a reply. Expect the socket to be shut down.
[{ "success": true }]
-------------------
+When the specified command cannot be parsed, `success` will be false and
+`parse_error` will be true:
+
+*Example:*
+-------------------
+[{ "success": false, "parse_error": true }]
+-------------------
+
[[_workspaces_reply]]
=== WORKSPACES reply