git.iko.soy/typeable/yaml
on master help sign in
Improved documentation
efe39e3Michael Snoyman
Data/Yaml.hs+15
compare with master
unifiedsplit
@@ -6,6 +6,21 @@
6{-# LANGUAGE PatternGuards #-}
6{-# LANGUAGE PatternGuards #-}
7{-# LANGUAGE ScopedTypeVariables #-}
7{-# LANGUAGE ScopedTypeVariables #-}
8{-# LANGUAGE OverloadedStrings #-}
8{-# 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.
9module Data.Yaml
24module Data.Yaml
10 ( -- * Types
25 ( -- * Types
11 Value (..)
26 Value (..)
yaml.cabal+9−3
@@ -1,17 +1,23 @@
1name: yaml
1name: yaml
2−version: 0.8.1
2+version: 0.8.1.1
3license: BSD3
3license: BSD3
4license-file: LICENSE
4license-file: LICENSE
5author: Michael Snoyman <michael@snoyman.com>, Anton Ageev <antage@gmail.com>,Kirill Simonov
5author: Michael Snoyman <michael@snoyman.com>, Anton Ageev <antage@gmail.com>,Kirill Simonov
6maintainer: Michael Snoyman <michael@snoyman.com>
6maintainer: Michael Snoyman <michael@snoyman.com>
7−synopsis: Low-level binding to the libyaml C library.
7+synopsis: Support for parsing and rendering YAML documents.
8description: Provides support for parsing and emitting Yaml documents.
8description: Provides support for parsing and emitting Yaml documents.
9 .
9 .
10 This package includes the full libyaml C library version 0.1.2 by Kirill
10 This package includes the full libyaml C library version 0.1.2 by Kirill
11 Simonov (<http://pyyaml.org/wiki/LibYAML>) in the package so you
11 Simonov (<http://pyyaml.org/wiki/LibYAML>) in the package so you
12 don't need to worry about any non-Haskell dependencies.
12 don't need to worry about any non-Haskell dependencies.
13+ .
14+ The package is broken down into two modules.
15+ "Data.Yaml" provides a high-level interface based
16+ around the JSON datatypes provided by the @aeson@
17+ package. "Text.Libyaml" provides a lower-level,
18+ streaming interface. For most users, "Data.Yaml" is recommended.
13category: Web
19category: Web
14−stability: unstable
20+stability: stable
15cabal-version: >= 1.8
21cabal-version: >= 1.8
16build-type: Simple
22build-type: Simple
17homepage: http://github.com/snoyberg/yaml/
23homepage: http://github.com/snoyberg/yaml/