Skip to content

Commit

Permalink
fix trapping time docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
Datseris committed Jan 14, 2019
1 parent adfd421 commit 473c5af
Showing 1 changed file with 2 additions and 3 deletions.
5 changes: 2 additions & 3 deletions src/rqa.jl
Original file line number Diff line number Diff line change
Expand Up @@ -162,9 +162,8 @@ Calculate the trapping time of the recurrence matrix `x`, ruling out the
points within the Theiler window of size `theiler` and diagonals shorter
than `lmin`.
This parameter is the average of the vertical line structures;
see [`vl_average](@ref).
The trapping time is the average of the vertical line structures and thus equal
to [`vl_average`](@ref).
"""
trappingtime(x::ARM; kwargs...) = vl_average(x; kwargs...)

Expand Down

0 comments on commit 473c5af

Please sign in to comment.