Skip to content

Commit 3a3e528

Browse files
committed
improve docs for Generic
1 parent 432890b commit 3a3e528

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

src/Data/Codec/Argonaut/Generic.purs

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,13 @@ import Data.Symbol (class IsSymbol, SProxy(..), reflectSymbol)
1313
-- | Encodes nullary sums with a Generic instance as strings that match the constructor names.
1414
-- |
1515
-- | ```purescript
16+
-- | import Data.Argonaut as J
17+
-- |
1618
-- | data MySum = Ctor1 | Ctor2 | MoarCtors
1719
-- | derive instance genericMySum ∷ Generic MySum _
1820
-- |
19-
-- | encode nullarySum Ctor1 == JString "Ctor1"
20-
-- | decode nullarySum JString "MoarCtors" == Right MoarCtors
21+
-- | encode nullarySum Ctor1 == J.fromString "Ctor1"
22+
-- | decode nullarySum (J.fromString "MoarCtors") == Right MoarCtors
2123
-- |```
2224
nullarySum a r. Generic a r NullarySumCodec r String CA.JsonCodec a
2325
nullarySum name =

0 commit comments

Comments
 (0)