sway

commit f1afef5533cac9c5d03e5fb372226e48ac1d8547
parent f5ca4c26acdd65aa6e7f2c2eb83f54e13323c403
Author: Rex Hackbro <rex.hackbro@mailbox.org>
Date:   Mon,  3 Aug 2020 00:30:35 +0200

document parse_error

Diffstat:
M
sway/sway-ipc.7.scd
 | 
7
+++++--

1 file changed, 5 insertions(+), 2 deletions(-)
diff --git a/sway/sway-ipc.7.scd b/sway/sway-ipc.7.scd
@@ -93,8 +93,10 @@ Parses and runs the payload as sway commands
 *REPLY*++
 An array of objects corresponding to each command that was parsed. Each object
 has the property _success_, which is a boolean indicating whether the command
-was successful. The object may also contain the property _error_, which is a
-human readable error message.
+was successful. The object may also contain the properties _error_ and _parse\_error_.
+The _error_ property is a human readable error message while _parse\_error_ is a
+boolean indicating whether the reason the command failed was because the command
+was unknown or not able to be parsed.
 
 *Example Reply:*
 ```
@@ -104,6 +106,7 @@ human readable error message.
 	},
 	{
 		"success": false,
+		"parse_error": true,
 		"error": "Invalid/unknown command"
 	}
 ]