cats icon indicating copy to clipboard operation
cats copied to clipboard

Add a documentation page on error handling

Open Daenyth opened this issue 3 years ago • 8 comments

There's some major gaps around error handling in the official docs, especially painful because the whole ecosystem relies on them - library users are often instructed to use MonadError/ApplicativeError error handling code, but it's not present in the documentation

  • Add a page on ApplicativeError/MonadError (one page, likely)
    • Either on that page or on its own page, provide a "cookbook" of common error handling examples

This is mentioned in #1801, but I thought it was worth calling out as its own issue

Daenyth avatar Jul 16 '20 14:07 Daenyth

Can I take this? I had been doing some trials on this, and this would help me understand them a bit better @Daenyth @barambani

dhinojosa avatar Aug 29 '20 22:08 dhinojosa

@dhinojosa Absolutely! Please hop on gitter and ask around if you run into anything you want help with while working on it. We're always very happy to have new contributors, and documentation makes the library better for all users :)

Daenyth avatar Aug 29 '20 23:08 Daenyth

brilliant @dhinojosa , thanks for doing it

barambani avatar Aug 30 '20 11:08 barambani

Thanks all, I have been meaning to add and join for a long time

dhinojosa avatar Aug 30 '20 21:08 dhinojosa

ApplicativeError is up for approval. #3593

dhinojosa avatar Sep 03 '20 22:09 dhinojosa

Waiting until the mdoc #3595 is approved and I will write the docs in mdoc.

dhinojosa avatar Sep 10 '20 04:09 dhinojosa

PR up for review. https://github.com/typelevel/cats/pull/3616

dhinojosa avatar Sep 26 '20 21:09 dhinojosa

PR up for review for MonadError, let me know what you think @Daenyth. I haven't added your tupling recommendation yet that you suggested in the previous PR.

#3639

dhinojosa avatar Oct 18 '20 19:10 dhinojosa