-
Notifications
You must be signed in to change notification settings - Fork 30
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Error handling docs #16
Labels
documentation
Improvements or additions to documentation
good first issue
Good for newcomers
help wanted
Extra attention is needed
Comments
This could go in the "The Library" section of the readme. Can't think of a better first issue for potential contributors to get their name up on the project! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
documentation
Improvements or additions to documentation
good first issue
Good for newcomers
help wanted
Extra attention is needed
The messaging syntax (including errors) should be detailed in the readme.
Messages come through
event
. Thewhere
field looks like this:[s, e]/[sys, self]/[description]
Where
s
means "successful" (such ass/self/live@path
) ande
means "error" (such ase/sys/read
).self
means we failed.sys
means the operating system failed.The
description
is usually a function name, an api, or a path. It's something extra.These events always have the
kind
field aswatcher
(as opposed tofile
,dir
, etc).The
what
field varies. When a watcher first starts watching,what
iscreate
. When a watcher dies, it'sdestroy
. Error messages are usuallyother
.We need to put this in the readme.
The text was updated successfully, but these errors were encountered: