correct reference to statespaceset

JuliaDynamics · Feb 23, 2023 · 82ab464 · 82ab464
1 parent 6a4c7cb
commit 82ab464
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 3 deletions.
diff --git a/Project.toml b/Project.toml
@@ -1,7 +1,7 @@
 name = "RecurrenceAnalysis"
 uuid = "639c3291-70d9-5ea2-8c5b-839eba1ee399"
 repo = "https://github.com/JuliaDynamics/RecurrenceAnalysis.jl.git"
-version = "2.0.1"
+version = "2.0.2"
 
 [deps]
 DelimitedFiles = "8bb1440f-4735-579b-a4ab-409b98df4dab"

diff --git a/docs/make.jl b/docs/make.jl
@@ -16,4 +16,4 @@ Downloads.download(
 )
 include("build_docs_with_style.jl")
 
-build_docs_with_style(pages, RecurrenceAnalysis)
+build_docs_with_style(pages, RecurrenceAnalysis, StateSpaceSets)
diff --git a/docs/src/rplots.md b/docs/src/rplots.md
@@ -173,3 +173,8 @@ The distance function used in [`RecurrenceMatrix`](@ref) and co. can be specifie
 ```@docs
 distancematrix
 ```
+
+## `StateSpaceSet` reference
+```@docs
+StateSpaceSet
+```
diff --git a/src/matrices/recurrence_matrix_types.jl b/src/matrices/recurrence_matrix_types.jl
@@ -2,6 +2,7 @@
 # AbstractRecurrenceMatrix type hierarchy
 ################################################################################
 # TODO: `RT` is `AbstractRecurrenceType`, but due to deprecations, it is allowed
+# to be anything at the moment
 abstract type AbstractRecurrenceMatrix{RT} <: AbstractMatrix{Bool} end
 const ARM = AbstractRecurrenceMatrix
 
@@ -87,8 +88,10 @@ SparseArrays.SparseMatrixCSC(R::ARM) = SparseMatrixCSC(R.data)
 """
     RecurrenceMatrix(x, ε; metric = Euclidean(), parallel::Bool)
 
-Create a recurrence matrix from trajectory `x` (either a `Dataset` or a `Vector`)
+Create a recurrence matrix from trajectory `x`
 and with recurrence threshold specification `ε`.
+`x` is either a [`StateSpaceSet`](@ref) for multivariate data
+or an `AbstractVector{<:Real}` for timeseries.
 
 If `ε::Real` is given, a [`RecurrenceThreshold`](@ref) is used to specify recurrences.
 Otherwise, any subtype of [`AbstractRecurrenceType`](@ref) may be given as `ε` instead.