codex-storage
/
nim-chronos
mirror of https://github.com/codex-storage/nim-chronos.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fix documentation for `or`.

This commit is contained in:
cheatfate 2020-04-21 07:33:31 +03:00
parent 2ecc5500c2
commit 357baa52a0
No known key found for this signature in database
GPG Key ID: 46ADD633A7201F95
1 changed files with 7 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
chronos/asyncfutures2.nim
View File

@ -494,8 +494,13 @@ proc `or`*[T, Y](fut1: Future[T], fut2: Future[Y]): Future[void] =
## Returns a future which will complete once either ``fut1`` or ``fut2``
## complete.
##
## If ``fut1`` or ``fut2`` will fail, result future will also fail with an
## error stored in ``fut1`` or ``fut2`` respectively.
## If ``fut1`` or ``fut2`` future is failed, the result future will also be
## failed with an error stored in ``fut1`` or ``fut2`` respectively.
##
## If both ``fut1`` and ``fut2`` future are completed or failed, the result
## future will depend on the state of ``fut1`` future. So if ``fut1`` future
## is failed, the result future will also be failed, if ``fut1`` future is
## completed, the result future will also be completed.
##
## If cancelled, ``fut1`` and ``fut2`` futures WILL NOT BE cancelled.
var retFuture = newFuture[void]("chronos.or")