]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
[doc] Reword sentinel object summary in dataclasses (GH-27792)
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Thu, 2 Sep 2021 16:37:55 +0000 (09:37 -0700)
committerGitHub <noreply@github.com>
Thu, 2 Sep 2021 16:37:55 +0000 (09:37 -0700)
This sentinel value (`MISSING`) is also used as default value for the `kw_only` parameter introduced in Python 3.10. It's cleaner to simply omit the usage here.

Co-authored-by: Ɓukasz Langa <lukasz@langa.pl>
(cherry picked from commit 767a17f35a581da664ac8cf5d67281da9485eebf)

Co-authored-by: Ville Korhonen <ville@xd.fi>
Doc/library/dataclasses.rst

index 5da05539c90b1ea65cbc5ea55981dc1af548a0d7..5915bacbcdc4ec8dcc96c208fe8bad5784ecb2a1 100644 (file)
@@ -221,10 +221,9 @@ Module contents
      c.mylist += [1, 2, 3]
 
    As shown above, the :const:`MISSING` value is a sentinel object used to
-   detect if the ``default`` and ``default_factory`` parameters are
-   provided.  This sentinel is used because ``None`` is a valid value
-   for ``default``.  No code should directly use the :const:`MISSING`
-   value.
+   detect if some parameters are provided by the user. This sentinel is
+   used because ``None`` is a valid value for some parameters with
+   a distinct meaning.  No code should directly use the :const:`MISSING` value.
 
    The parameters to :func:`field` are: