Skip to content

Commit

Permalink
fix: docs for ignore-isolation
Browse files Browse the repository at this point in the history
  • Loading branch information
PatrickAlphaC committed Nov 17, 2024
1 parent 77ee8be commit d35c6c9
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 1 deletion.
6 changes: 6 additions & 0 deletions docs/source/core_concepts/testing/staging_markers.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,17 @@ A lot of developers `should` run some sanity checks on a live network, for examp

Maybe after you deploy your contracts, you want to run a quick test suite to make sure everything is ok, this is where "staging" tests come into play.

.. note::

At this time, you also have to use ``@pytest.mark.ignore_isolation`` to work with titanoboa.

How to use staging markers
==========================

.. code-block:: python
@pytest.mark.staging
@pytest.mark.ignore_isolation
def test_staging_test(counter_contract):
counter_contract.increment()
assert counter_contract.number() == 2
Expand Down Expand Up @@ -70,6 +75,7 @@ To have a staging test also run on local and forked networks, you can do:
.. code-block:: python
@pytest.mark.staging
@pytest.mark.ignore_isolation
@pytest.mark.local # See this!
def test_staging_test(counter_contract):
counter_contract.increment()
Expand Down
2 changes: 1 addition & 1 deletion uv.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit d35c6c9

Please sign in to comment.