Update note description

Signed-off-by: Gábor Lipták <gliptak@gmail.com>
HypothesisWorks · Nov 13, 2021 · e2b1f41 · e2b1f41
1 parent 288ba3e
commit e2b1f41
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 2 deletions.
diff --git a/hypothesis-python/RELEASE.rst b/hypothesis-python/RELEASE.rst
@@ -0,0 +1,4 @@
+RELEASE_TYPE: patch
+
+This patch updates documentation of :func:`~hypothesis.note`
+(:issue:`3147`).
diff --git a/hypothesis-python/docs/details.rst b/hypothesis-python/docs/details.rst
@@ -43,7 +43,7 @@ intermediate steps of your test. That's where the ``note`` function comes in:
     Shuffle: [1, 0]
     ls != ls2
 
-The note is printed in the final run of the test in order to include any
+The note is printed for the minimal failing example of the test in order to include any
 additional information you might need in your test.
 
 

diff --git a/hypothesis-python/src/hypothesis/control.py b/hypothesis-python/src/hypothesis/control.py
@@ -116,7 +116,7 @@ def should_note():
 
 
 def note(value: str) -> None:
-    """Report this value in the final execution."""
+    """Report this value for the minimal failing example."""
     if should_note():
         report(value)