diff options
-rw-r--r-- | sway/sway-ipc.7.scd | 7 |
1 files changed, 5 insertions, 2 deletions
diff --git a/sway/sway-ipc.7.scd b/sway/sway-ipc.7.scd index 018080fe..1b855959 100644 --- a/sway/sway-ipc.7.scd +++ b/sway/sway-ipc.7.scd | |||
@@ -93,8 +93,10 @@ Parses and runs the payload as sway commands | |||
93 | *REPLY*++ | 93 | *REPLY*++ |
94 | An array of objects corresponding to each command that was parsed. Each object | 94 | An array of objects corresponding to each command that was parsed. Each object |
95 | has the property _success_, which is a boolean indicating whether the command | 95 | has the property _success_, which is a boolean indicating whether the command |
96 | was successful. The object may also contain the property _error_, which is a | 96 | was successful. The object may also contain the properties _error_ and _parse\_error_. |
97 | human readable error message. | 97 | The _error_ property is a human readable error message while _parse\_error_ is a |
98 | boolean indicating whether the reason the command failed was because the command | ||
99 | was unknown or not able to be parsed. | ||
98 | 100 | ||
99 | *Example Reply:* | 101 | *Example Reply:* |
100 | ``` | 102 | ``` |
@@ -104,6 +106,7 @@ human readable error message. | |||
104 | }, | 106 | }, |
105 | { | 107 | { |
106 | "success": false, | 108 | "success": false, |
109 | "parse_error": true, | ||
107 | "error": "Invalid/unknown command" | 110 | "error": "Invalid/unknown command" |
108 | } | 111 | } |
109 | ] | 112 | ] |