From: Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Date: Sat, 4 Jan 2025 19:03:01 +0000 (+0100)
Subject: [3.13] Docs: amend json.dump() post gh-128482 (GH-128489) (#128493)
X-Git-Tag: v3.13.2~146
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=62b4ca0d53f7b273e42b55c5307d46be33596b35;p=thirdparty%2FPython%2Fcpython.git

[3.13] Docs: amend json.dump() post gh-128482 (GH-128489) (#128493)

(cherry picked from commit 87ee76062a7eb9c0fa2b94e36cfed21d86ae90ac)

Co-authored-by: Erlend E. Aasland <erlend@python.org>
---

diff --git a/Doc/library/json.rst b/Doc/library/json.rst
index ce0e652ee58f..21f36cb38f11 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``.