Skip to content

Commit 6029edb

Browse files
Add limitation of single test_value to Effect docstrings
1 parent 844849a commit 6029edb

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

causal_testing/testing/causal_test_outcome.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,8 @@ def __str__(self):
8989

9090

9191
class Positive(SomeEffect):
92-
"""An extension of TestOutcome representing that the expected causal effect should be positive."""
92+
"""An extension of TestOutcome representing that the expected causal effect should be positive.
93+
Currently only single values are supported for the test value"""
9394

9495
def apply(self, res: CausalTestResult) -> bool:
9596
if res.ci_valid() and not super().apply(res):
@@ -104,7 +105,8 @@ def apply(self, res: CausalTestResult) -> bool:
104105

105106

106107
class Negative(SomeEffect):
107-
"""An extension of TestOutcome representing that the expected causal effect should be negative."""
108+
"""An extension of TestOutcome representing that the expected causal effect should be negative.
109+
Currently only single values are supported for the test value"""
108110

109111
def apply(self, res: CausalTestResult) -> bool:
110112
if res.ci_valid() and not super().apply(res):

0 commit comments

Comments
 (0)