Skip to content
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.

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

Update project documentation to account for typed errors #80

Merged
merged 1 commit into from
Jun 19, 2020

Conversation

thomashoneyman
Copy link
Contributor

What does this pull request do?

Updates the README to account for the new typed errors implementation in #73.

Other Notes:

I also made a pair of other small updates.

  1. I added a parseJson function that parses String -> Either JsonDecodeError Json. This is mostly for convenience -- it's possible to just use jsonParser from argonaut-core and then lmap (TypeMismatch "JSON"), but I think this is a bit much to expect a regular user to have to bikeshed about in their codebase. Providing a function that gets Json from a String and which is already compatible with the decoders seems like the way to go. It's called parseJson to avoid a name conflict with jsonParser.
  2. I renamed the Errors module to Error, as it only defines a single error type and exports it.

@thomashoneyman thomashoneyman changed the title Update project documentation Update project documentation to account for typed errors Jun 19, 2020
@thomashoneyman thomashoneyman self-assigned this Jun 19, 2020
@thomashoneyman thomashoneyman merged commit 3a7be1b into master Jun 19, 2020
@thomashoneyman thomashoneyman deleted the docs-update branch June 19, 2020 06:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants