summaryrefslogtreecommitdiffstats
path: root/Doc/library/json.rst
diff options
context:
space:
mode:
authorErlend E. Aasland <erlend@python.org>2025-01-04 18:57:59 (GMT)
committerGitHub <noreply@github.com>2025-01-04 18:57:59 (GMT)
commit87ee76062a7eb9c0fa2b94e36cfed21d86ae90ac (patch)
treee62736d9798e6e30ba345eded113021bd5db4483 /Doc/library/json.rst
parentf28d471fbe99f9eaac05d60ed40da47b0b56fe86 (diff)
downloadcpython-87ee76062a7eb9c0fa2b94e36cfed21d86ae90ac.zip
cpython-87ee76062a7eb9c0fa2b94e36cfed21d86ae90ac.tar.gz
cpython-87ee76062a7eb9c0fa2b94e36cfed21d86ae90ac.tar.bz2
Docs: amend json.dump() post gh-128482 (#128489)
Diffstat (limited to 'Doc/library/json.rst')
-rw-r--r--Doc/library/json.rst13
1 files changed, 8 insertions, 5 deletions
diff --git a/Doc/library/json.rst b/Doc/library/json.rst
index f11109f..169291f 100644
--- a/Doc/library/json.rst
+++ b/Doc/library/json.rst
@@ -154,10 +154,6 @@ Basic Usage
:term:`file-like object`) using this :ref:`Python-to-JSON conversion table
<py-to-json-table>`.
- To use a custom :class:`JSONEncoder` subclass (for example, one that overrides the
- :meth:`~JSONEncoder.default` method to serialize additional types), specify it with the
- *cls* keyword argument; otherwise :class:`JSONEncoder` is used.
-
.. note::
Unlike :mod:`pickle` and :mod:`marshal`, JSON is not a framed protocol,
@@ -197,6 +193,13 @@ Basic Usage
If ``True`` (the default), their JavaScript equivalents
(``NaN``, ``Infinity``, ``-Infinity``) are used.
+ :param cls:
+ If set, a custom JSON encoder with the
+ :meth:`~JSONEncoder.default` method overridden,
+ for serializing into custom datatypes.
+ If ``None`` (the default), :class:`!JSONEncoder` is used.
+ :type cls: a :class:`JSONEncoder` subclass
+
:param indent:
If a positive integer or string, JSON array elements and
object members will be pretty-printed with that indent level.
@@ -223,7 +226,7 @@ Basic Usage
If ``None`` (the default), :exc:`!TypeError` is raised.
:type default: :term:`callable` | None
- :param sort_keys:
+ :param bool sort_keys:
If ``True``, dictionaries will be outputted sorted by key.
Default ``False``.