From e2b1f41108a3ab1ee168ec20378e9fe39a136d76 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?G=C3=A1bor=20Lipt=C3=A1k?= Date: Fri, 12 Nov 2021 21:17:14 -0500 Subject: [PATCH] Update note description MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Gábor Lipták --- hypothesis-python/RELEASE.rst | 4 ++++ hypothesis-python/docs/details.rst | 2 +- hypothesis-python/src/hypothesis/control.py | 2 +- 3 files changed, 6 insertions(+), 2 deletions(-) create mode 100644 hypothesis-python/RELEASE.rst diff --git a/hypothesis-python/RELEASE.rst b/hypothesis-python/RELEASE.rst new file mode 100644 index 0000000000..ff8b57ab04 --- /dev/null +++ b/hypothesis-python/RELEASE.rst @@ -0,0 +1,4 @@ +RELEASE_TYPE: patch + +This patch updates documentation of :func:`~hypothesis.note` +(:issue:`3147`). \ No newline at end of file diff --git a/hypothesis-python/docs/details.rst b/hypothesis-python/docs/details.rst index a3ba31def2..30bddc07d3 100644 --- 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 index 3132e8c76b..e042136eda 100644 --- 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)