Skip to content

Commit

Permalink
Move healthcheck docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Zac-HD committed Apr 16, 2023
1 parent 8c2220e commit a95b6bb
Show file tree
Hide file tree
Showing 3 changed files with 39 additions and 35 deletions.
35 changes: 0 additions & 35 deletions hypothesis-python/docs/healthchecks.rst

This file was deleted.

19 changes: 19 additions & 0 deletions hypothesis-python/docs/settings.rst
Original file line number Diff line number Diff line change
Expand Up @@ -223,3 +223,22 @@ by your conftest you can load one with the command line option ``--hypothesis-pr
.. code:: bash
$ pytest tests --hypothesis-profile <profile-name>
-------------
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.

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 ``list(HealthCheck)`` will disable all health checks.

.. autoclass:: hypothesis.HealthCheck
:undoc-members:
:inherited-members:
:exclude-members: all
20 changes: 20 additions & 0 deletions hypothesis-python/docs/supported.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,26 @@ noted as provisional, in which case they may be changed in minor releases.
Undocumented attributes, modules, and behaviour may include breaking
changes in patch releases.


.. _deprecation-policy:

------------
Deprecations
------------

Deprecated features will emit warnings for at least six
months, and then be removed in the following major release.

Note however that not all warnings are subject to this grace period;
sometimes we strengthen validation by adding a warning and these may
become errors immediately at a major release.

We use custom exception and warning types, so you can see
exactly where an error came from, or turn only our warnings into errors.

.. autoclass:: hypothesis.errors.HypothesisDeprecationWarning


---------------
Python versions
---------------
Expand Down

0 comments on commit a95b6bb

Please sign in to comment.