jyapayne/Nim
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

threadpool: minor documentation improvement

Browse source
This commit is contained in:
Andreas Rumpf 2018-04-18 17:12:47 +02:00
commit 17cb2f2d4c
1 changed files with 1 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

2
lib/pure/concurrency/threadpool.nim
View file

@ -245,7 +245,7 @@ proc `^`*[T](fv: FlowVar[T]): T =
proc awaitAny*(flowVars: openArray[FlowVarBase]): int = proc awaitAny*(flowVars: openArray[FlowVarBase]): int =
## awaits any of the given flowVars. Returns the index of one flowVar for ## awaits any of the given flowVars. Returns the index of one flowVar for
## which a value arrived. A flowVar only supports one call to 'awaitAny' at ## which a value arrived. A flowVar only supports one call to 'awaitAny' at
## the same time. That means if you await([a,b]) and await([b,c]) the second ## the same time. That means if you awaitAny([a,b]) and awaitAny([b,c]) the second
## call will only await 'c'. If there is no flowVar left to be able to wait ## call will only await 'c'. If there is no flowVar left to be able to wait
## on, -1 is returned. ## on, -1 is returned.
## **Note**: This results in non-deterministic behaviour and so should be ## **Note**: This results in non-deterministic behaviour and so should be