stdlib: asyncdispatch: all: Docs updated.

This commit is contained in:
Константин Молчанов 2016-06-02 22:23:27 +03:00
commit 3538e00fc7

View file

@ -356,11 +356,14 @@ proc `or`*[T, Y](fut1: Future[T], fut2: Future[Y]): Future[void] =
return retFuture return retFuture
proc all*[T](futs: varargs[Future[T]]): auto = proc all*[T](futs: varargs[Future[T]]): auto =
## Returns a future which will complete once all futures in ``futs`` ## Returns a future which will complete once
## complete. ## all futures in ``futs`` complete.
## ##
## The resulting future will hold the values of all awaited futures, ## If the awaited futures are not ``Future[void]``, the returned future
## in the order they are passed. ## will hold the values of all awaited futures in a sequence.
##
## If the awaited futures *are* ``Future[void]``,
## this proc returns ``Future[void]``.
when T is void: when T is void:
var var