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

Documentation tweaks #19

Open
Vlix opened this issue Apr 24, 2020 · 5 comments
Open

Documentation tweaks #19

Vlix opened this issue Apr 24, 2020 · 5 comments

Comments

@Vlix
Copy link
Owner

Vlix commented Apr 24, 2020

The test functions like migrateRoundTripProp don't need a second type application.
Adjust examples, but note that adding the second type gives guarantee it's migrating from the right type.

@Vlix
Copy link
Owner Author

Vlix commented Nov 13, 2020

Also:

  • "Containers" in the comment of the SafeJSON [a] instance shouldn't be a link.
  • 'Version'\'s should probably be 'Version''s?
  • setVersion' doesn't link the quoted words in it's example (remove quotes?)

@Vlix
Copy link
Owner Author

Vlix commented Dec 25, 2020

Also:

* `"Containers"` in the comment of the `SafeJSON [a]` instance shouldn't be a link.

* `'Version'\'s` should probably be `'Version''s`?

* `setVersion'` doesn't link the quoted words in it's example (remove quotes?)

These have been addressed in #26

@Vlix
Copy link
Owner Author

Vlix commented Aug 18, 2022

In the README

λ> Just vals = parseMaybe safeFromJSON/parseJSON incomingJSON :: Maybe [Value]

This part makes no sense: in the example, incomingJSON is already [Value], so why are we parsing it to a [Value] again... AND then not double fmap-ing!

Just remove this line.

@Vlix
Copy link
Owner Author

Vlix commented Sep 10, 2023

incomingJSON is already [Value]

No, no it's not. It's Value, that's why it's being parsed to "just force the array" to then setVersion on the individual Values, which then get encoded correctly.

@Vlix
Copy link
Owner Author

Vlix commented Sep 10, 2023

The test functions like migrateRoundTripProp don't need a second type application. Adjust examples, but note that adding the second type gives guarantee it's migrating from the right type.

This is the only thing in this issue that is still a "to do", but I want to test this out before removing it in the comments.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant