Merge pull request #4243 from stapelberg/parseerror

ipc: document parse_error COMMAND reply field
tdemin · Nov 3, 2020 · 1d9160f · 1d9160f
2 parents 829b4d2 + c22b35c
commit 1d9160f
Showing 1 changed file with 8 additions and 0 deletions.
diff --git 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