jyapayne/Nim
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: clarify asyncCheck vs waitFor

Browse source
This commit is contained in:
citycide 2018-10-27 11:52:57 -05:00 • committed by Dominik Picheta
commit 4362ba7293
2 changed files with 5 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

4
lib/pure/asyncdispatch.nim
View file

@ -145,7 +145,9 @@ export asyncfutures, asyncstreams
## ##
## Futures should **never** be discarded. This is because they may contain ## Futures should **never** be discarded. This is because they may contain
## errors. If you do not care for the result of a Future then you should ## errors. If you do not care for the result of a Future then you should
## use the ``asyncCheck`` procedure instead of the ``discard`` keyword. ## use the ``asyncCheck`` procedure instead of the ``discard`` keyword. Note
## however that this does not wait for completion, and you should use
## ``waitFor`` for that purpose.
## ##
## Examples ## Examples
## -------- ## --------

3
lib/pure/asyncfutures.nim
View file

@ -339,7 +339,8 @@ proc asyncCheck*[T](future: Future[T]) =
## Sets a callback on ``future`` which raises an exception if the future ## Sets a callback on ``future`` which raises an exception if the future
## finished with an error. ## finished with an error.
## ##
## This should be used instead of ``discard`` to discard void futures. ## This should be used instead of ``discard`` to discard void futures,
## or use ``waitFor`` if you need to wait for the future's completion.
assert(not future.isNil, "Future is nil") assert(not future.isNil, "Future is nil")
future.callback = future.callback =
proc () = proc () =