@@ -6,6 +6,21 @@
66{-# LANGUAGE PatternGuards #-}
77{-# LANGUAGE ScopedTypeVariables #-}
88{-# LANGUAGE OverloadedStrings #-}
9+-- | Provides a high-level interface for processing YAML files.
10+--
11+-- This module reuses most of the infrastructure from the @aeson@ package.
12+-- This means that you can use all of the existing tools for JSON
13+-- processing for processing YAML files. As a result, much of the
14+-- documentation below mentions JSON; do not let that confuse you, it's
15+-- intentional.
16+--
17+-- For the most part, YAML content translates directly into JSON, and
18+-- therefore there is very little data loss. If you need to deal with YAML
19+-- more directly (e.g., directly deal with aliases), you should use the
20+-- "Text.Libyaml" module instead.
21+--
22+-- For documentation on the @aeson@ types, functions, classes, and
23+-- operators, please see the @Data.Aeson@ module of the @aeson@ package.
924module Data.Yaml
1025 ( -- * Types
1126 Value (..)