summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorÉric Araujo <merwok@netwok.org>2012-01-16 09:09:20 (GMT)
committerÉric Araujo <merwok@netwok.org>2012-01-16 09:09:20 (GMT)
commit6f7aa00c1eb40d9a74e25e6bc3ab7c8efbe8e866 (patch)
tree2a90c050d96939b704e023c878d0e8e2c95495dc
parent73cec21af2bfd729e9b9a72a97bc661211db6077 (diff)
downloadcpython-6f7aa00c1eb40d9a74e25e6bc3ab7c8efbe8e866.zip
cpython-6f7aa00c1eb40d9a74e25e6bc3ab7c8efbe8e866.tar.gz
cpython-6f7aa00c1eb40d9a74e25e6bc3ab7c8efbe8e866.tar.bz2
Document json.dump ensure_ascii parameter (#13770)
-rw-r--r--Doc/library/json.rst4
1 files changed, 4 insertions, 0 deletions
diff --git a/Doc/library/json.rst b/Doc/library/json.rst
index 4ee17f2..a791259 100644
--- a/Doc/library/json.rst
+++ b/Doc/library/json.rst
@@ -125,6 +125,10 @@ Basic Usage
:class:`bytes` objects. Therefore, ``fp.write()`` must support :class:`str`
input.
+ If *ensure_ascii* is ``True`` (the default), the output is guaranteed to
+ have all incoming non-ASCII characters escaped. If *ensure_ascii* is
+ ``False``, these characters will be output as-is.
+
If *check_circular* is ``False`` (default: ``True``), then the circular
reference check for container types will be skipped and a circular reference
will result in an :exc:`OverflowError` (or worse).