taigrr/systemctl
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

updates to README

Browse Source
This commit is contained in:
Tai Groot 2021-05-15 20:13:36 -07:00
parent e7bbc166c3
commit 45fda65ede
Signed by: taigrr
GPG Key ID: D00C269A87614812
1 changed files with 2 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
README.md
View File

@ -42,11 +42,12 @@ All functions return a predefinied error type, and it is highly recommended thes
## Context support
All calls into this library support go's `context` functionality.
Therefore, blocking calls can time out according to the callee's needs, and the returned error should be checked to see if a timeout occurred (`ErrExecTimeout`).
Therefore, blocking calls can time out according to the caller's needs, and the returned error should be checked to see if a timeout occurred (`ErrExecTimeout`).
## TODO
- [ ] Set up `go test` testing
- [ ] Document each function using `godoc` standards
## Simple example