Skip to content

Commit 7671f04

Browse files
committed
DOC: Clarify what means for series to cross over
Closes #386
1 parent 4f21a65 commit 7671f04

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

backtesting/lib.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -80,8 +80,8 @@ def barssince(condition: Sequence[bool], default=np.inf) -> int:
8080

8181
def cross(series1: Sequence, series2: Sequence) -> bool:
8282
"""
83-
Return `True` if `series1` and `series2` just crossed (either
84-
direction).
83+
Return `True` if `series1` and `series2` just crossed
84+
(above or below) each other.
8585
8686
>>> cross(self.data.Close, self.sma)
8787
True
@@ -92,7 +92,7 @@ def cross(series1: Sequence, series2: Sequence) -> bool:
9292

9393
def crossover(series1: Sequence, series2: Sequence) -> bool:
9494
"""
95-
Return `True` if `series1` just crossed over
95+
Return `True` if `series1` just crossed over (above)
9696
`series2`.
9797
9898
>>> crossover(self.data.Close, self.sma)

0 commit comments

Comments
 (0)