[Python-checkins] bpo-45346: Keep docs consistent regarding true and false values (GH-28697)
rhettinger
webhook-mailer at python.org
Sat Oct 2 14:48:20 EDT 2021
https://github.com/python/cpython/commit/db91b058d5d4fbff4185982095d90fe6a2741aed
commit: db91b058d5d4fbff4185982095d90fe6a2741aed
branch: main
author: Raymond Hettinger <rhettinger at users.noreply.github.com>
committer: rhettinger <rhettinger at users.noreply.github.com>
date: 2021-10-02T13:48:08-05:00
summary:
bpo-45346: Keep docs consistent regarding true and false values (GH-28697)
files:
M Doc/library/ast.rst
M Doc/reference/compound_stmts.rst
M Lib/test/test_builtin.py
diff --git a/Doc/library/ast.rst b/Doc/library/ast.rst
index e21151bd4ef79..d84c841fa4a08 100644
--- a/Doc/library/ast.rst
+++ b/Doc/library/ast.rst
@@ -1266,7 +1266,7 @@ Pattern matching
the pattern matches the subject.
``body`` contains a list of nodes to execute if the pattern matches and
- the result of evaluating the guard expression is truthy.
+ the result of evaluating the guard expression is true.
.. doctest::
diff --git a/Doc/reference/compound_stmts.rst b/Doc/reference/compound_stmts.rst
index f24222f5fd9e9..5936cdf5ffc30 100644
--- a/Doc/reference/compound_stmts.rst
+++ b/Doc/reference/compound_stmts.rst
@@ -585,8 +585,8 @@ Here's an overview of the logical flow of a match statement:
#. If the pattern succeeds, the corresponding guard (if present) is evaluated. In
this case all name bindings are guaranteed to have happened.
- * If the guard evaluates as truthy or missing, the ``block`` inside ``case_block`` is
- executed.
+ * If the guard evaluates as true or is missing, the ``block`` inside
+ ``case_block`` is executed.
* Otherwise, the next ``case_block`` is attempted as described above.
@@ -637,10 +637,10 @@ The logical flow of a ``case`` block with a ``guard`` follows:
#. If the pattern succeeded, evaluate the ``guard``.
- * If the ``guard`` condition evaluates to "truthy", the case block is
+ * If the ``guard`` condition evaluates as true, the case block is
selected.
- * If the ``guard`` condition evaluates to "falsy", the case block is not
+ * If the ``guard`` condition evaluates as false, the case block is not
selected.
* If the ``guard`` raises an exception during evaluation, the exception
diff --git a/Lib/test/test_builtin.py b/Lib/test/test_builtin.py
index bd8353d038b6f..6dc4fa555021c 100644
--- a/Lib/test/test_builtin.py
+++ b/Lib/test/test_builtin.py
@@ -1861,7 +1861,7 @@ def test_warning_notimplemented(self):
# be evaluated in a boolean context (virtually all such use cases
# are a result of accidental misuse implementing rich comparison
# operations in terms of one another).
- # For the time being, it will continue to evaluate as truthy, but
+ # For the time being, it will continue to evaluate as a true value, but
# issue a deprecation warning (with the eventual intent to make it
# a TypeError).
self.assertWarns(DeprecationWarning, bool, NotImplemented)
More information about the Python-checkins
mailing list