Skip to content

extended documentation for catchException #13

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

extended documentation for catchException #13

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 10 additions & 4 deletions docs/Control/Monad/Eff/Exception.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,15 +71,21 @@ main = do
catchException :: forall a eff. (Error -> Eff eff a) -> Eff (err :: EXCEPTION | eff) a -> Eff eff a
```

Catch an exception by providing an exception handler.
Catch an exception by providing an exception handler for the given effectful Monad.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure if this adds anything, but the use of "Monad" is probably not what you intended. The only monad in use here is Eff (err :: EXCEPTION | eff), so you might say "in the Eff monad" instead. Note, the function arguments are not monads, since only type constructors can be monads, not values.


This handler removes the `EXCEPTION` effect.
This handler also removes the `EXCEPTION` effect.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"also" in addition to what else though?


For example:

```purescript
main = catchException print do
trace "Exceptions thrown in this block will be logged to the console"
nastyOp = catchException catcher thrower
where
catcher e = do
log "catched the bugger!"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd rather avoid this sort of language in core library docs, relatively mild as it might be.

--return the message of the error for example
return $ message e
thrower = do
throw "Big bad bug"
```

#### `throw`
Expand Down