From c22b35c293ad8c473e7c802117dba97c98141382 Mon Sep 17 00:00:00 2001 From: Michael Stapelberg Date: Tue, 3 Nov 2020 09:48:28 +0100 Subject: [PATCH] ipc: document parse_error COMMAND reply field fixes #4166 --- docs/ipc | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/ipc b/docs/ipc index 62f6555c4..bb8719cb4 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