docs: clarify asyncCheck vs waitFor

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

View file

@ -145,7 +145,9 @@ export asyncfutures, asyncstreams
##
## 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
## 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
## --------