summaryrefslogtreecommitdiff
path: root/_doc
diff options
context:
space:
mode:
authorAnthon van der Neut <anthon@mnt.org>2019-01-08 18:34:04 +0100
committerAnthon van der Neut <anthon@mnt.org>2019-01-08 18:34:04 +0100
commitdff05e12978e07a7cdd3c4ce09f9c058aca2e7e3 (patch)
tree0918cc4fe0f97f4848a9639fd4da192b5f87c01a /_doc
parent4c9add02bb1126436897f61417c1e3a45311f4ac (diff)
downloadruamel.yaml-dff05e12978e07a7cdd3c4ce09f9c058aca2e7e3.tar.gz
close issue #272 YAML instances should be discarded on load/dump exception
Diffstat (limited to '_doc')
-rw-r--r--_doc/api.ryd6
1 files changed, 6 insertions, 0 deletions
diff --git a/_doc/api.ryd b/_doc/api.ryd
index 1b4208d..a295565 100644
--- a/_doc/api.ryd
+++ b/_doc/api.ryd
@@ -94,6 +94,12 @@ Initially only the typical operations are supported, but in principle
all functionality of the old interface will be available via
``YAML`` instances (if you are using something that isn't let me know).
+If a parse or dump fails, and throws and exception, the state of the
+`YAML()` instance is not guaranteed to be able to handle further
+processing. You should, at that point to recreate the YAML instance before
+proceeding.
+
+
Loading
+++++++