NorfairKing/autodocodec
1
1
Fork 0
mirror of https://github.com/NorfairKing/autodocodec.git synced 2024-11-22 22:33:01 +03:00
Code Issues Projects Releases Wiki Activity

Merge pull request #25 from kenranunderscore/fix-typo

Browse Source 
Fix some typos
This commit is contained in:
Tom Sydney Kerckhove 2022-08-31 10:08:29 +02:00 committed by GitHub
commit e337d68110
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
autodocodec/src/Autodocodec/Codec.hs
View File

@ -58,7 +58,7 @@ import GHC.Generics (Generic)
-- --
-- also called an "Autodocodec". -- also called an "Autodocodec".
-- --
-- In an ideal situation, this type would have only one type paramater: 'Codec value'. -- In an ideal situation, this type would have only one type parameter: 'Codec value'.
-- This does not work very well because we want to be able to implement 'Functor' and 'Applicative', which each require a kind '* -> *'. -- This does not work very well because we want to be able to implement 'Functor' and 'Applicative', which each require a kind '* -> *'.
-- So instead we use two type parameters. -- So instead we use two type parameters.
-- --
@ -539,7 +539,7 @@ eitherCodec = possiblyJointEitherCodec
-- --
-- === 'HasCodec' instance for sum types with an encoding that is definitely disjoint. -- === 'HasCodec' instance for sum types with an encoding that is definitely disjoint.
-- --
-- The 'eitherCodec' can be used to implement 'HasCodec' instances sum types -- The 'eitherCodec' can be used to implement 'HasCodec' instances for sum types
-- for which the encoding is definitely disjoint. -- for which the encoding is definitely disjoint.
-- --
-- >>> data War = WorldWar Word8 | OtherWar Text deriving (Show, Eq) -- >>> data War = WorldWar Word8 | OtherWar Text deriving (Show, Eq)
@ -1497,7 +1497,7 @@ matchChoiceCodecAs union c1 c2 renderingChooser =
-- --
-- > disjointMatchChoiceCodec = matchChoicesCodecAs DisjointUnion -- > disjointMatchChoiceCodec = matchChoicesCodecAs DisjointUnion
matchChoicesCodec :: matchChoicesCodec ::
-- | Codecs, each which their own rendering matcher -- | Codecs, each with their own rendering matcher
[(input -> Maybe input, Codec context input output)] -> [(input -> Maybe input, Codec context input output)] ->
-- | Fallback codec, in case none of the matchers in the list match -- | Fallback codec, in case none of the matchers in the list match
Codec context input output -> Codec context input output ->
@ -1513,7 +1513,7 @@ matchChoicesCodec = matchChoicesCodecAs PossiblyJointUnion
-- --
-- > disjointMatchChoiceCodec = matchChoicesCodecAs DisjointUnion -- > disjointMatchChoiceCodec = matchChoicesCodecAs DisjointUnion
disjointMatchChoicesCodec :: disjointMatchChoicesCodec ::
-- | Codecs, each which their own rendering matcher -- | Codecs, each with their own rendering matcher
[(input -> Maybe input, Codec context input output)] -> [(input -> Maybe input, Codec context input output)] ->
-- | Fallback codec, in case none of the matchers in the list match -- | Fallback codec, in case none of the matchers in the list match
Codec context input output -> Codec context input output ->
@ -1523,7 +1523,7 @@ disjointMatchChoicesCodec = matchChoicesCodecAs DisjointUnion
-- | An even more general version of 'matchChoicesCodec' and 'disjointMatchChoicesCodec' -- | An even more general version of 'matchChoicesCodec' and 'disjointMatchChoicesCodec'
matchChoicesCodecAs :: matchChoicesCodecAs ::
Union -> Union ->
-- | Codecs, each which their own rendering matcher -- | Codecs, each with their own rendering matcher
[(input -> Maybe input, Codec context input output)] -> [(input -> Maybe input, Codec context input output)] ->
-- | Fallback codec, in case none of the matchers in the list match -- | Fallback codec, in case none of the matchers in the list match
Codec context input output -> Codec context input output ->