From 7a7fa04db3c41ac5f56e756e5074d2367776a8dc Mon Sep 17 00:00:00 2001 From: Americo Date: Wed, 23 Jun 2021 11:34:43 -0600 Subject: [PATCH 1/2] Clarify section on errors --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 6698188..bf5bba9 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ Bi-directional codecs for [argonaut](https://github.com/purescript-contrib/pures This library is build on [`purescript-codec`](https://github.com/garyb/purescript-codec) and offers a different approach to dealing with JSON encoding/decoding than [`purescript-argonaut-codecs`](https://github.com/purescript-contrib/purescript-argonaut-codecs). Instead of using type classes, codecs are constructed as values explicitly. As long as the basic codec values provided by this library are used, the codecs are guaranteed to roundtrip successfully. -The errors reported from this library are a little better than those provided by `purescript-argonaut-codecs` too - they contain the full JSON structure to the point of failure, and the error can be inspected as a value before being printed as a string. +The errors reported from this library are a little better than those provided by `purescript-argonaut-codecs` too - when used with `showJsonDecodeError` they show a helpful explanation of what when wrong and where. For more information on the motivation behind this library, I [wrote a bit about my problems with typeclass codecs](http://code.slipthrough.net/2018/03/13/thoughts-on-typeclass-codecs/) previously. From 8e69e8849e92f0235d7b7cfac68d0c9ee6839211 Mon Sep 17 00:00:00 2001 From: Americo Date: Thu, 10 Mar 2022 10:12:04 -0700 Subject: [PATCH 2/2] fix typo --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index bf5bba9..97475a5 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ Bi-directional codecs for [argonaut](https://github.com/purescript-contrib/pures This library is build on [`purescript-codec`](https://github.com/garyb/purescript-codec) and offers a different approach to dealing with JSON encoding/decoding than [`purescript-argonaut-codecs`](https://github.com/purescript-contrib/purescript-argonaut-codecs). Instead of using type classes, codecs are constructed as values explicitly. As long as the basic codec values provided by this library are used, the codecs are guaranteed to roundtrip successfully. -The errors reported from this library are a little better than those provided by `purescript-argonaut-codecs` too - when used with `showJsonDecodeError` they show a helpful explanation of what when wrong and where. +The errors reported from this library are a little better than those provided by `purescript-argonaut-codecs` too - when used with `showJsonDecodeError` they show a helpful explanation of what went wrong and where. For more information on the motivation behind this library, I [wrote a bit about my problems with typeclass codecs](http://code.slipthrough.net/2018/03/13/thoughts-on-typeclass-codecs/) previously.