From b67e130fda46fb258ac9c974b73cd6f8c70665dc Mon Sep 17 00:00:00 2001
From: Petri Lehtinen <petri@digip.org>
Date: Thu, 15 Oct 2009 21:06:59 +0300
Subject: [PATCH] json_dumpf: Document the output shortage on error

---
 doc/apiref.rst | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/doc/apiref.rst b/doc/apiref.rst
index 818ec51..9c28fb8 100644
--- a/doc/apiref.rst
+++ b/doc/apiref.rst
@@ -514,6 +514,9 @@ is in UTF-8.
 
    Write the JSON representation of *root* to the stream *output*.
    *flags* is described above. Returns 0 on success and -1 on error.
+   If an error occurs, something may have already been written to
+   *output*. In this case, the output is undefined and most likely not
+   valid JSON.
 
 .. cfunction:: int json_dump_file(const json_t *json, const char *path, unsigned long flags)
 
-- 
2.1.4