Skip to content

Commit 8a91c4e

Browse files
committed
better docs
1 parent fe6bcef commit 8a91c4e

File tree

3 files changed

+19
-16
lines changed

3 files changed

+19
-16
lines changed

MODULES.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,8 +46,9 @@ Unwraps the canceler function from the newtype that wraps it.
4646
cancelWith :: forall e a. Aff e a -> Canceler e -> Aff e a
4747
```
4848

49-
If the first asynchronous computation is canceled, then the specified
50-
canceler will also be called.
49+
This function allows you to attach a custom canceler to an asynchronous
50+
computation. If the computation is canceled, then the custom canceler
51+
will be run along side the computation's own canceler.
5152

5253
#### `launchAff`
5354

output/examples.js

Lines changed: 13 additions & 12 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

src/Control/Monad/Aff.purs

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,8 +50,9 @@ module Control.Monad.Aff
5050
cancel :: forall e. Canceler e -> Error -> Aff e Boolean
5151
cancel (Canceler f) = f
5252

53-
-- | If the first asynchronous computation is canceled, then the specified
54-
-- | canceler will also be called.
53+
-- | This function allows you to attach a custom canceler to an asynchronous
54+
-- | computation. If the computation is canceled, then the custom canceler
55+
-- | will be run along side the computation's own canceler.
5556
cancelWith :: forall e a. Aff e a -> Canceler e -> Aff e a
5657
cancelWith aff c = runFn3 _cancelWith nonCanceler aff c
5758

0 commit comments

Comments
 (0)