Skip to content

Commit f1afef5

Browse files
JayceFayneemersion
authored andcommitted
document parse_error
1 parent f5ca4c2 commit f1afef5

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

sway/sway-ipc.7.scd

+5-2
Original file line numberDiff line numberDiff line change
@@ -93,8 +93,10 @@ Parses and runs the payload as sway commands
9393
*REPLY*++
9494
An array of objects corresponding to each command that was parsed. Each object
9595
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
97-
human readable error message.
96+
was successful. The object may also contain the properties _error_ and _parse\_error_.
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.
98100

99101
*Example Reply:*
100102
```
@@ -104,6 +106,7 @@ human readable error message.
104106
},
105107
{
106108
"success": false,
109+
"parse_error": true,
107110
"error": "Invalid/unknown command"
108111
}
109112
]

0 commit comments

Comments
 (0)