alex/swayfx
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

document parse_error

Browse source
This commit is contained in:
Rex Hackbro 2020-08-03 00:30:35 +02:00 committed by Simon Ser
parent f5ca4c26ac
commit f1afef5533
1 changed files with 5 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
sway/sway-ipc.7.scd
View file

@ -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"
}
]