@@ -18,21 +18,8 @@
18-- For documentation on the @aeson@ types, functions, classes, and
18-- For documentation on the @aeson@ types, functions, classes, and
19-- operators, please see the @Data.Aeson@ module of the @aeson@ package.
19-- operators, please see the @Data.Aeson@ module of the @aeson@ package.
21−-- == Examples
21+-- Look in the examples directory of the source repository for some initial
22−--
22+-- pointers on how to use this library.
23−-- Decode into a data structure by specifying the desired type to the 'decode'
26−-- > {-# LANGUAGE OverloadedStrings #-}
28−-- > import qualified Data.Yaml as Y
31−-- > print $ (Y.decode "[1,2,3]" :: Maybe [Integer])
33−-- You can go one step further and decode into a custom type by implementing
34−-- 'FromJSON' for that type. This is also appropriate where extra
35−-- normalization, formatting or manipulation of the YAML is required on decode.
37#if (defined (ghcjs_HOST_OS))
24#if (defined (ghcjs_HOST_OS))
38module Data.Yaml {-# WARNING "GHCJS is not supported yet (will break at runtime once called)." #-}
25module Data.Yaml {-# WARNING "GHCJS is not supported yet (will break at runtime once called)." #-}