purescript-contrib/purescript-argonaut-codecs

Wrong type shown in docs

BrandonHowe opened this issue · 1 comments

Describe the bug
In Pursuit, the type of decodeJson (as listed on the DecodeJson typecclass) is shown as Json -> Either String a. However, it is Json -> Either JsonDecodeError a in the code.

Expected behavior
An updated documentation, this is the only error that I have come across thus far, however, there could be other errors.

Ah, you're right, this uses the wrong type:

https://github.com/purescript-contrib/purescript-argonaut-codecs/blob/main/docs/README.md#automatic-encoding-with-encodejson-and-encodejson

It looks correct elsewhere in the documentation so it should just be that line that needs to be updated. Would you like to patch it?