summaryrefslogtreecommitdiff
path: root/docs/internals/contributing/writing-code
diff options
context:
space:
mode:
Diffstat (limited to 'docs/internals/contributing/writing-code')
-rw-r--r--docs/internals/contributing/writing-code/coding-style.txt5
1 files changed, 5 insertions, 0 deletions
diff --git a/docs/internals/contributing/writing-code/coding-style.txt b/docs/internals/contributing/writing-code/coding-style.txt
index f9952b3661..43db31501e 100644
--- a/docs/internals/contributing/writing-code/coding-style.txt
+++ b/docs/internals/contributing/writing-code/coding-style.txt
@@ -71,6 +71,11 @@ Python style
and :meth:`~unittest.TestCase.assertWarnsRegex` only if you need regular
expression matching.
+ Use :meth:`assertIs(…, True/False)<unittest.TestCase.assertIs>` for testing
+ boolean values, rather than :meth:`~unittest.TestCase.assertTrue` and
+ :meth:`~unittest.TestCase.assertFalse`, so you can check the actual boolean
+ value, not the truthiness of the expression.
+
* In test docstrings, state the expected behavior that each test demonstrates.
Don't include preambles such as "Tests that" or "Ensures that".