Tweak docs

HypothesisWorks · Feb 4, 2023 · 6db5fc5 · 6db5fc5
1 parent 77d9d3e
commit 6db5fc5
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 19 deletions.
diff --git a/hypothesis-python/docs/changes.rst b/hypothesis-python/docs/changes.rst
@@ -36,16 +36,17 @@ and thus recursed due to the new pretty reprs in Hypothesis :ref:`v6.65.0`
 6.66.1 - 2023-02-03
 -------------------
 
-This makes :func:`hypothesis.extra.numpy.from_dtype` pass through the parameter `allow_subnormal` for complex dtypes.
+This makes :func:`~hypothesis.extra.numpy.from_dtype` pass through the parameter
+``allow_subnormal`` for complex dtypes.
 
 .. _v6.66.0:
 
 -------------------
 6.66.0 - 2023-02-02
 -------------------
 
-This release adds a ``width`` parameter to :func:`hypothesis.strategies.complex_numbers`,
-analogously to :func:`hypothesis.strategies.floats`.
+This release adds a ``width`` parameter to :func:`~hypothesis.strategies.complex_numbers`,
+analogously to :func:`~hypothesis.strategies.floats`.
 
 Thanks to Felix Divo for the new feature!
 

diff --git a/hypothesis-python/docs/healthchecks.rst b/hypothesis-python/docs/healthchecks.rst
@@ -2,23 +2,11 @@
 Health checks
 =============
 
-Hypothesis tries to detect common mistakes and things that will cause difficulty
-at run time in the form of a number of 'health checks'.
+Hypothesis' health checks are designed to detect and warn you about performance
+problems where your tests are slow, inefficient, or generating very large examples.
 
-These include detecting and warning about:
-
-* Strategies with very slow data generation
-* Strategies which filter out too much
-* Recursive strategies which branch too much
-* Tests that are unlikely to complete in a reasonable amount of time.
-
-If any of these scenarios are detected, Hypothesis will emit a warning about them.
-
-The general goal of these health checks is to warn you about things that you are doing that might
-appear to work but will either cause Hypothesis to not work correctly or to perform badly.
-
-To selectively disable health checks, use the
-:obj:`~hypothesis.settings.suppress_health_check` setting.
+If this is expected, e.g. when generating large arrays or dataframes, you can selectively
+disable them with the :obj:`~hypothesis.settings.suppress_health_check` setting.
 The argument for this parameter is a list with elements drawn from any of
 the class-level attributes of the HealthCheck class.
 Using a value of ``HealthCheck.all()`` will disable all health checks.