Skip to content

Commit f5e5721

Browse files
committed
doc tweaks to effect.testing - mostly reorder things
1 parent b3c74a4 commit f5e5721

File tree

1 file changed

+15
-4
lines changed

1 file changed

+15
-4
lines changed

effect/testing.py

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
"""
2-
Various functions for testing effects.
2+
Various functions and dispatchers for testing effects.
33
4-
The main goal of this code is to allow you to safely tests your effects
5-
in a way that makes it hard to *accidentally* perform real effects in your
6-
tests.
4+
Usually the best way to test effects is by using :func:`effect.sync_perform`
5+
with a :obj:`SequenceDispatcher`.
76
"""
87

98
from __future__ import print_function
@@ -20,6 +19,18 @@
2019

2120
import six
2221

22+
__all__ = [
23+
'SequenceDispatcher',
24+
'EQDispatcher',
25+
'EQFDispatcher',
26+
'resolve_effect',
27+
'fail_effect',
28+
'Stub',
29+
'ESConstant', 'ESError', 'ESFunc',
30+
'resolve_stubs',
31+
'resolve_stub',
32+
]
33+
2334

2435
@attr.s
2536
class Stub(object):

0 commit comments

Comments
 (0)