status-im
/
NimYAML
mirror of https://github.com/status-im/NimYAML.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

doc link fixes

This commit is contained in:
Felix Krause 2016-10-01 15:19:42 +02:00
parent 721632322b
commit 834c4b174a
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
yaml.nim
View File

@ -10,12 +10,12 @@
## ##
## There are three high-level APIs which are probably most useful: ## There are three high-level APIs which are probably most useful:
## ##
## * The serialization API in `serialization <yaml/serialization.html>`_ enables ## * The serialization API in `serialization <yaml.serialization.html>`_ enables
## you to load YAML data directly into native Nim types, and reversely dump ## you to load YAML data directly into native Nim types, and reversely dump
## native Nim types as YAML. ## native Nim types as YAML.
## * The DOM API in `dom <yaml/dom.html>`_ parses YAML files in a tree structure ## * The DOM API in `dom <yaml.dom.html>`_ parses YAML files in a tree structure
## which you can navigate. ## which you can navigate.
## * The JSON API in `tojson <yaml/tojson.html>`_ parses YAML files into the ## * The JSON API in `tojson <yaml.tojson.html>`_ parses YAML files into the
## Nim stdlib's JSON structure, which may be useful if you have other modules ## Nim stdlib's JSON structure, which may be useful if you have other modules
## which expect JSON input. Note that the serialization API is able to write ## which expect JSON input. Note that the serialization API is able to write
## and load JSON; you do not need the JSON API for that. ## and load JSON; you do not need the JSON API for that.
@ -24,18 +24,18 @@
## enables you to process YAML input as data stream which does not need to be ## enables you to process YAML input as data stream which does not need to be
## loaded into RAM completely at once. It consists of the following modules: ## loaded into RAM completely at once. It consists of the following modules:
## ##
## * The stream API in `stream <yaml/stream.html>`_ defines the central type for ## * The stream API in `stream <yaml.stream.html>`_ defines the central type for
## stream processing, ``YamlStream``. It also contains definitions and ## stream processing, ``YamlStream``. It also contains definitions and
## constructor procs for stream events. ## constructor procs for stream events.
## * The parser API in `parser <yaml/parser.html>`_ gives you direct access to ## * The parser API in `parser <yaml.parser.html>`_ gives you direct access to
## the YAML parser's output. ## the YAML parser's output.
## * The presenter API in `presenter <yaml/presenter.html>`_ gives you direct ## * The presenter API in `presenter <yaml/presenter.html>`_ gives you direct
## access to the presenter, i.e. the module that renders a YAML character ## access to the presenter, i.e. the module that renders a YAML character
## stream. ## stream.
## * The taglib API in `taglib <yaml/taglib.html>`_ provides a data structure ## * The taglib API in `taglib <yaml.taglib.html>`_ provides a data structure
## for keeping track of YAML tags that are generated by the parser or used in ## for keeping track of YAML tags that are generated by the parser or used in
## the presenter. ## the presenter.
## * The hints API in `hints <yaml/hints.html>`_ provides a simple proc for ## * The hints API in `hints <yaml.hints.html>`_ provides a simple proc for
## guessing the type of a scalar value. ## guessing the type of a scalar value.
import yaml.dom, yaml.hints, yaml.parser, yaml.presenter, import yaml.dom, yaml.hints, yaml.parser, yaml.presenter,