From 3538e00fc7b317e4b4adb32ad5fdf2c72d35d481 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=D0=9A=D0=BE=D0=BD=D1=81=D1=82=D0=B0=D0=BD=D1=82=D0=B8?= =?UTF-8?q?=D0=BD=20=D0=9C=D0=BE=D0=BB=D1=87=D0=B0=D0=BD=D0=BE=D0=B2?= Date: Thu, 2 Jun 2016 22:23:27 +0300 Subject: [PATCH] stdlib: asyncdispatch: `all`: Docs updated. --- lib/pure/asyncdispatch.nim | 11 +++++++---- 1 file 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. ## - ## The resulting future will hold the values of all awaited futures, - ## in the order they are passed. + ## If the awaited futures are not ``Future[void]``, the returned future + ## 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: var