pretty-types 0.1.0.2 → 0.1.0.3

raw patch · 2 files changed

+10/−10 lines, 2 filesPVP ok

version bump matches the API change (PVP)

API changes (from Hackage documentation)

Files

• pretty-types.cabal +1/−1
• src/Data/Type/Pretty.hs +9/−9

@@ -1,5 +1,5 @@ name:                pretty-types-version:             0.1.0.2+version:             0.1.0.3 synopsis:            A small pretty printing DSL for complex types. description:         Please see README.md homepage:            https://github.com/sheyll/pretty-types#readme

@@ -3,20 +3,20 @@ -- = Type Pretty Printing -- -- == Printing Custom Types--- The main usecase is of course printing one own complex types. ----- Convert a custom type to the 'PrettyType' eDSL, then render it using--- 'ptShow'.+-- The main usecase of this library is rendering one's own complex types to+-- pretty 'String' values, e.g. for debugging and tracing purposes. ----- 'ToPretty' is the hooks for pretty type printing custom types,--- while 'showPretty' renders a type with a 'ToPretty' instance.+-- One way to create 'PrettyType' /documents/ is to define 'ToPretty' instances+-- for your types by combining the promoted constructors of 'PrettyType'. ----- 'ToPretty' is an open type family, that maps types to `PrettyType`s. One way--- to create 'PrettyType' /documents/ is to define instances for your types,--- which construct a type of kind 'PrettyType' using the promoted constructors--- of 'PrettyType'.+-- 'ToPretty' is an open type family, that converts a custom type to a+-- `PrettyType`. -- -- Use the type aliases to get rid of unticked or even ticked promoteds.+--+-- 'showPretty' eventually crafts a 'String' value from a proxy to they custom+-- type. -- -- == Example --