Skip to content

Commit

Permalink
Merge pull request #3202 from rouge8/pytest-raises-sphinx-parameters
Browse files Browse the repository at this point in the history
Add Sphinx parameter docs for `match` and `message` args to `pytest.raises()`
  • Loading branch information
nicoddemus authored Feb 10, 2018
2 parents c04e248 + ffee213 commit e7bcc85
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 0 deletions.
4 changes: 4 additions & 0 deletions _pytest/python_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -453,6 +453,10 @@ def raises(expected_exception, *args, **kwargs):
Assert that a code block/function call raises ``expected_exception``
and raise a failure exception otherwise.
:arg message: if specified, provides a custom failure message if the
exception is not raised
:arg match: if specified, asserts that the exception matches a text or regex
This helper produces a ``ExceptionInfo()`` object (see below).
You may use this function as a context manager::
Expand Down
1 change: 1 addition & 0 deletions changelog/3202.doc.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Add Sphinx parameter docs for ``match`` and ``message`` args to ``pytest.raises``.

0 comments on commit e7bcc85

Please sign in to comment.