diff options
| author | Anthon van der Neut <anthon@mnt.org> | 2020-10-15 15:37:04 +0200 |
|---|---|---|
| committer | Anthon van der Neut <anthon@mnt.org> | 2020-10-15 15:37:04 +0200 |
| commit | 4f1ad1c392bd557405e9901c5b8750d12a4f1260 (patch) | |
| tree | b9e37c122157756cf090ec353172f562ef96c072 /_doc | |
| parent | 1bdf43c8200b3e61c68a947f88cf40a81ddc26eb (diff) | |
| download | ruamel.yaml-4f1ad1c392bd557405e9901c5b8750d12a4f1260.tar.gz | |
explain round-tripping
Diffstat (limited to '_doc')
| -rw-r--r-- | _doc/basicuse.ryd | 10 | ||||
| -rw-r--r-- | _doc/overview.ryd | 5 |
2 files changed, 5 insertions, 10 deletions
diff --git a/_doc/basicuse.ryd b/_doc/basicuse.ryd index 0b0acf5..ca5139b 100644 --- a/_doc/basicuse.ryd +++ b/_doc/basicuse.ryd @@ -15,12 +15,6 @@ data = dict(a=1) Basic Usage *********** -*This is the new (0.15+) interface for ``ruamel.yaml``, it is still in -the process of being fleshed out*. Please pin your dependency to -``ruamel.yaml<0.15`` for production software. - ------- - You load a YAML document using:: --- !python | from ruamel.yaml import YAML @@ -33,8 +27,8 @@ in this ``doc`` can be a file pointer (i.e. an object that has the ``.read()`` method, a string or a ``pathlib.Path()``. ``typ='safe'`` accomplishes the same as what ``safe_load()`` did before: loading of a document without resolving unknown tags. Provide ``pure=True`` to -enforce using the pure Python implementation (faster C libraries will be used -when possible/available) +enforce using the pure Python implementation, otherwise the faster C libraries will be used +when possible/available but these behave slightly different (and sometimes more like a YAML 1.1 loader). Dumping works in the same way:: --- !code | diff --git a/_doc/overview.ryd b/_doc/overview.ryd index 86b7f10..38b9b52 100644 --- a/_doc/overview.ryd +++ b/_doc/overview.ryd @@ -10,8 +10,9 @@ Overview derivative of Kirill Simonov's `PyYAML 3.11 <https://bitbucket.org/xi/pyyaml>`_. -``ruamel.yaml`` supports `YAML 1.2`_ and has round-trip loaders and dumpers -that preserves, among others: +``ruamel.yaml`` supports `YAML 1.2`_ and has round-trip loaders and dumpers. +A round-trip is a YAML load-modify-save sequence and ruamel.yaml tries to +preserve, among others: - comments - block style and key ordering are kept, so you can diff the round-tripped |