diff options
Diffstat (limited to 'lib')
| -rw-r--r-- | lib/pure/asyncdispatch.nim | 11 |
1 files changed, 7 insertions, 4 deletions
diff --git a/lib/pure/asyncdispatch.nim b/lib/pure/asyncdispatch.nim index 7cf1a36e3..7d765ce75 100644 --- a/lib/pure/asyncdispatch.nim +++ b/lib/pure/asyncdispatch.nim @@ -356,11 +356,14 @@ proc `or`*[T, Y](fut1: Future[T], fut2: Future[Y]): Future[void] = return retFuture proc all*[T](futs: varargs[Future[T]]): auto = - ## Returns a future which will complete once all futures in ``futs`` - ## complete. + ## Returns a future which will complete once + ## all futures in ``futs`` complete. + ## + ## If the awaited futures are not ``Future[void]``, the returned future + ## will hold the values of all awaited futures in a sequence. ## - ## The resulting future will hold the values of all awaited futures, - ## in the order they are passed. + ## If the awaited futures *are* ``Future[void]``, + ## this proc returns ``Future[void]``. when T is void: var |