From 45fda65ede88637697267f82f3d0b5d38072e048 Mon Sep 17 00:00:00 2001 From: Tai Groot Date: Sat, 15 May 2021 20:13:36 -0700 Subject: [PATCH] updates to README --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index fd9d386..4893194 100644 --- a/README.md +++ b/README.md @@ -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