summary refs log tree commit diff stats
path: root/lib/pure/asyncdispatch.nim
diff options
context:
space:
mode:
authorКонстантин Молчанов <moigagoo@km.local>2016-06-02 22:23:27 +0300
committerКонстантин Молчанов <moigagoo@km.local>2016-06-02 22:23:27 +0300
commit3538e00fc7b317e4b4adb32ad5fdf2c72d35d481 (patch)
treed2a5d77dc11e43b4abafe8a60ef12e00819dd0a4 /lib/pure/asyncdispatch.nim
parent83af9888f584f354a5318812e9c90f3f3f210f19 (diff)
downloadNim-3538e00fc7b317e4b4adb32ad5fdf2c72d35d481.tar.gz
stdlib: asyncdispatch: `all`: Docs updated.
Diffstat (limited to 'lib/pure/asyncdispatch.nim')
-rw-r--r--lib/pure/asyncdispatch.nim11
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