]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
[3.12] Docs: amend json.dump() post gh-128482 (GH-128489) (#128494)
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Sat, 4 Jan 2025 19:04:13 +0000 (20:04 +0100)
committerGitHub <noreply@github.com>
Sat, 4 Jan 2025 19:04:13 +0000 (19:04 +0000)
(cherry picked from commit 87ee76062a7eb9c0fa2b94e36cfed21d86ae90ac)

Co-authored-by: Erlend E. Aasland <erlend@python.org>
Doc/library/json.rst

index aa33b175659b56aaac1457682af41b76f1e994d1..eff8808a440528cf754f6bcf4f6bf413c6dc7906 100644 (file)
@@ -143,10 +143,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,
@@ -186,6 +182,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.
@@ -212,7 +215,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``.