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/overview.ryd | |
| parent | 1bdf43c8200b3e61c68a947f88cf40a81ddc26eb (diff) | |
| download | ruamel.yaml-4f1ad1c392bd557405e9901c5b8750d12a4f1260.tar.gz | |
explain round-tripping
Diffstat (limited to '_doc/overview.ryd')
| -rw-r--r-- | _doc/overview.ryd | 5 |
1 files changed, 3 insertions, 2 deletions
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 |