From fda30dc92142daf5f3076d8d71b646d0c7e37344 Mon Sep 17 00:00:00 2001 From: xWafl <35458851+xWafl@users.noreply.github.com> Date: Sun, 30 Aug 2020 07:48:02 -0400 Subject: [PATCH 1/3] fix: change String to JsonDecodeError in docs --- docs/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/README.md b/docs/README.md index eebdd73..5881066 100644 --- a/docs/README.md +++ b/docs/README.md @@ -75,7 +75,7 @@ We can automatically decode `Json` using the `DecodeJson` type class ([pursuit]( Every type within `User` has an instance for `DecodeJson`, which means we can use the `decodeJson` function to try to decode a `Json` value into our type. Once again, integer and string values will be decoded directly from the `Json`, but containing types like `Record` and `Maybe` will also require instances for the types they contain. ```purs -decodeJson :: DecodeJson a => Json -> Either String a +decodeJson :: DecodeJson a => Json -> Either JsonDecodeError a ``` > Tip: To parse a JSON string as a `Json` value, you can use the `parseJson` function (which can fail). If you are sure you have valid JSON, then consider writing it in an FFI file and foreign importing it as `Json` as described in the [`argonaut-core` documentation](https://github.com/purescript-contrib/purescript-argonaut-core#introducing-json-values). From 7d7d4a64ea8dc0275afc0770a7dbfb9125a5ff9f Mon Sep 17 00:00:00 2001 From: xWafl <35458851+xWafl@users.noreply.github.com> Date: Sun, 30 Aug 2020 07:52:14 -0400 Subject: [PATCH 2/3] Add changes to the changelog --- docs/CHANGELOG.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md index bb34d86..3bc9340 100644 --- a/docs/CHANGELOG.md +++ b/docs/CHANGELOG.md @@ -12,4 +12,10 @@ Bugfixes: Other improvements: +## [0.0.1] - 2020-08-30 + +Bugfixes: + +Changed type in docs of `decodeJson` from `forall a. DecodeJson a => Json -> Either String a` to `forall a. DecodeJson a => Json -> Either JsonDecodeError a`. + ## [0.0.0] - 2020-01-01 From baf3a4c16bdf476331e742e5de74f25ed1fb21cc Mon Sep 17 00:00:00 2001 From: xWafl <35458851+xWafl@users.noreply.github.com> Date: Sun, 30 Aug 2020 07:54:42 -0400 Subject: [PATCH 3/3] Moved changes to "Unreleased" section in changelog --- docs/CHANGELOG.md | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md index 3bc9340..95e9ba4 100644 --- a/docs/CHANGELOG.md +++ b/docs/CHANGELOG.md @@ -10,12 +10,8 @@ New features: Bugfixes: -Other improvements: - -## [0.0.1] - 2020-08-30 +* Changed type in docs of `decodeJson` from `forall a. DecodeJson a => Json -> Either String a` to `forall a. DecodeJson a => Json -> Either JsonDecodeError a`. -Bugfixes: - -Changed type in docs of `decodeJson` from `forall a. DecodeJson a => Json -> Either String a` to `forall a. DecodeJson a => Json -> Either JsonDecodeError a`. +Other improvements: ## [0.0.0] - 2020-01-01