erius/shad-go
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

README: [keylock] a bit more clear doc for "cancel" argument

Browse source
This commit is contained in:
Eugene K 2020-03-19 17:55:01 +00:00 committed by Fedor Korotkiy
parent 6ed75536af
commit 1a31a226cb
1 changed files with 1 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
keylock/README.md
View file

@ -11,7 +11,7 @@ type KeyLock interface {
// Upon successful completion, function guarantees that no other call with intersecting set of keys
// will finish, until unlock() is called.
//
// If cancel channel is closed, function returns immediately.
// If cancel channel is closed, function stops trying to lock received keys and returns immediately
LockKeys(keys []string, cancel <-chan struct{}) (canceled bool, unlock func())
}
```