summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorVille Korhonen <ville@xd.fi>2021-09-02 16:03:22 +0000
committerGitHub <noreply@github.com>2021-09-02 18:03:22 +0200
commit767a17f35a581da664ac8cf5d67281da9485eebf (patch)
treef3c7ce7580c79dee44ec5e53d4e0054ae455e561
parentf0b63d5b56a6324f5f86807d9548c7b38aa2a8f7 (diff)
downloadcpython-git-767a17f35a581da664ac8cf5d67281da9485eebf.tar.gz
[doc] Reword sentinel object summary in dataclasses (GH-27792)
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>
-rw-r--r--Doc/library/dataclasses.rst7
1 files changed, 3 insertions, 4 deletions
diff --git a/Doc/library/dataclasses.rst b/Doc/library/dataclasses.rst
index de7dfae15e..a7144094c6 100644
--- a/Doc/library/dataclasses.rst
+++ b/Doc/library/dataclasses.rst
@@ -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: