Skip to content

Commit

Permalink
docs: dev_revert_msg
Browse files Browse the repository at this point in the history
  • Loading branch information
iamdefinitelyahuman committed Nov 23, 2020
1 parent 263e299 commit a26dbef
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions docs/api-test.rst
Original file line number Diff line number Diff line change
Expand Up @@ -132,11 +132,12 @@ RevertContextManager

The ``RevertContextManager`` closely mimics the behaviour of :func:`pytest.raises <pytest.raises>`.

.. py:class:: brownie.test.plugin.RevertContextManager(revert_msg=None)
.. py:class:: brownie.test.plugin.RevertContextManager(revert_msg=None, dev_revert_msg=None)
Context manager used to handle :func:`VirtualMachineError <brownie.exceptions.VirtualMachineError>` exceptions. Raises ``AssertionError`` if no transaction has reverted when the context closes.

* ``revert_msg``: Optional. Raises an ``AssertionError`` if the transaction does not revert with this error string.
* ``revert_msg``: Optional. Raises if the transaction does not revert with this error string.
* ``dev_revert_msg``: Optional. Raises if the transaction does not revert with this :ref:`dev revert string<dev-revert>`.

This class is available as ``brownie.reverts`` when ``pytest`` is active.

Expand Down

0 comments on commit a26dbef

Please sign in to comment.