Skip to content
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

Open
e-dant opened this issue Oct 23, 2022 · 1 comment
Open

Error handling docs #16

e-dant opened this issue Oct 23, 2022 · 1 comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed

Comments

@e-dant
Copy link
Owner

e-dant commented Oct 23, 2022

The messaging syntax (including errors) should be detailed in the readme.

Messages come through event. The where field looks like this:

[s, e]/[sys, self]/[description]

Where s means "successful" (such as s/self/live@path) and e means "error" (such as e/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 as watcher (as opposed to file, dir, etc).

The what field varies. When a watcher first starts watching, what is create. When a watcher dies, it's destroy. Error messages are usually other.

We need to put this in the readme.

@e-dant e-dant added the documentation Improvements or additions to documentation label Oct 23, 2022
@e-dant e-dant self-assigned this Oct 23, 2022
@e-dant e-dant added the good first issue Good for newcomers label Jan 17, 2023
@e-dant
Copy link
Owner Author

e-dant commented Jan 17, 2023

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!

@e-dant e-dant added the help wanted Extra attention is needed label Jun 18, 2023
@e-dant e-dant removed their assignment Jun 19, 2023
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
Projects
None yet
Development

No branches or pull requests

1 participant