summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorChris Withers <chris@withers.org>2020-01-29 19:41:50 +0000
committerChris Withers <chris@withers.org>2020-01-29 19:46:36 +0000
commitfe43b42af2907a2990cd7223338b381a3e7ca01a (patch)
treeef7a514ab557d5f2440a2f0b904c23f97b630780
parent7fd17496a8b840d6f51dfdc639a8310ec8efa36e (diff)
downloadmock-fe43b42af2907a2990cd7223338b381a3e7ca01a.tar.gz
another code coverage pattern
-rw-r--r--docs/index.txt14
1 files changed, 14 insertions, 0 deletions
diff --git a/docs/index.txt b/docs/index.txt
index 1f2b32a..bc3df99 100644
--- a/docs/index.txt
+++ b/docs/index.txt
@@ -117,6 +117,20 @@ Backporting rules
def will_never_be_called(): pass
+- If code such as this causes coverage checking to drop below 100%:
+
+ .. code-block:: python
+
+ def will_never_be_called():
+ yield
+
+ It should be adjusted to the following pattern, preferably upstream,
+ so that the ``.coveragerc`` in this repo knows to ignore it:
+
+ .. code-block:: python
+
+ def will_never_be_called(): yield
+
Backporting process
-------------------