garyb / purescript-codec-argonaut

Bi-directional JSON codecs for argonaut
MIT License
39 stars 16 forks source link

More docs #22

Closed garyb closed 5 years ago

garyb commented 5 years ago

@joneshf How's this?

garyb commented 5 years ago

@joneshf Thanks for reviewing so far! I'll take a look at that object/record stuff, and also I realised I forgot to say anything about the migration module at all in the README, so will at least add a mention of that too.

joneshf commented 5 years ago

Oh, you don't have to change anything right now. I think this is great as is!

garyb commented 5 years ago

Yeah, moving stuff around was causing more of a ruckus than I felt like dealing with just now. :wink:

I added the object variation for C.D.A.Record though, and just added a comment to the object/record stuff in the main module to check out the C.D.A.Record versions instead.

Also added a few more doc comments, made the doc comment code examples more consistent, added imports to the code examples, etc.

joneshf commented 5 years ago

This is awesome. Thanks so much for doing all this!

garyb commented 5 years ago

It was long overdue :wink: