Mention GHC generics support in documentation #6
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
phadej
reviewed
Feb 4, 2019
| @@ -67,6 +67,20 @@ import GHC.Generics | |||
| -- in a single row of the query result. Otherwise, a 'ConversionFailed' | |||
| -- exception will be thrown. | |||
| -- | |||
| -- You can also derive 'FromRow' for your data type using GHC generics, like | |||
| -- this: | |||
There was a problem hiding this comment.
should one mention Product type? Should we add an instance with TypeError for :+:?
There was a problem hiding this comment.
@phadej: I think adding new instances is outside of the scope for this pull request (which is just to mention that it even exists)
However, I can update the documentation to mention that it only works for product types and does not support sum types
... as suggested by @phadej
phadej
reviewed
Feb 6, 2019
| -- deriving ('GHC.Generics.Generic', 'FromRow') | ||
| -- @ | ||
| -- | ||
| -- Note that this only works for product types (i.e. records) and does not |
There was a problem hiding this comment.
Should i.e. be e.g. because data Foo = Foo Int String is a product type, but is not a record.
... as suggested by @phadej
|
Thanks! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.