[Python-checkins] [doc] Reword sentinel object summary in dataclasses (GH-27792)
miss-islington
webhook-mailer at python.org
Thu Sep 2 12:38:04 EDT 2021
https://github.com/python/cpython/commit/7aa58f5425189c95927d1620df8d6b0ba57d393a
commit: 7aa58f5425189c95927d1620df8d6b0ba57d393a
branch: 3.10
author: Miss Islington (bot) <31488909+miss-islington at users.noreply.github.com>
committer: miss-islington <31488909+miss-islington at users.noreply.github.com>
date: 2021-09-02T09:37:55-07:00
summary:
[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 at langa.pl>
(cherry picked from commit 767a17f35a581da664ac8cf5d67281da9485eebf)
Co-authored-by: Ville Korhonen <ville at xd.fi>
files:
M Doc/library/dataclasses.rst
diff --git a/Doc/library/dataclasses.rst b/Doc/library/dataclasses.rst
index 5da05539c90b1..5915bacbcdc4e 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:
More information about the Python-checkins
mailing list