summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorOrestis Floros <orestisflo@gmail.com>2020-11-03 11:51:42 +0100
committerGitHub <noreply@github.com>2020-11-03 11:51:42 +0100
commit1d9160f2d247dbaa83fb62f02fd7041dec767fc2 (patch)
tree372983886b8318f07968a0910249f80b83325d04
parent829b4d2b7c7e8a9b2a6a43a7b638691d889d110e (diff)
parentc22b35c293ad8c473e7c802117dba97c98141382 (diff)
downloadi3-1d9160f2d247dbaa83fb62f02fd7041dec767fc2.tar.gz
i3-1d9160f2d247dbaa83fb62f02fd7041dec767fc2.zip
Merge pull request #4243 from stapelberg/parseerror
ipc: document parse_error COMMAND reply field
-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