[Docs] Add a page on error handling
Open
Nobody has claimed this yet.
- Dominant language
- Scala
- Stars
- 1.7k
- Forks
- 175
- Avg merge
- 5d 14h
- Merged PRs (30d)
- 9
Description
- Include an example of the most common errors that you'd get
- Incorrect types being most common
- Screenshots of what the error output looks like (even if only to have as an easily-linked selling point)
- A section on any built-in error combinators (like how doobie has
attemptSomeSqland so on) - A tiny overview of the common cats methods that you'd use (especially since cats lacks in-depth error handling docs)
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Review the repository's existing documentation structure and the error-handling behavior for incorrect types. Cover common errors, representative output screenshots, built-in error combinators, and a concise overview of the relevant Cats methods; done means the page addresses each requested topic with usable examples.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- postgres, scala
- Domain
- databases, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100