threadpool: minor documentation improvement

This commit is contained in:
Andreas Rumpf
2018-04-18 17:12:47 +02:00
parent 5d13e3f28b
commit 17cb2f2d4c

View File

@@ -245,7 +245,7 @@ proc `^`*[T](fv: FlowVar[T]): T =
proc awaitAny*(flowVars: openArray[FlowVarBase]): int =
## 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
## 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
## on, -1 is returned.
## **Note**: This results in non-deterministic behaviour and so should be