ipc: document parse_error COMMAND reply field

fixes #4166
2020-11-03 09:48:28 +01:00 · 2020-11-03 09:48:28 +01:00 · c22b35c293
commit c22b35c293
parent 19fbe1d30c
1 changed files with 8 additions and 0 deletions
--- 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