fixed Whitening docs

JuliaStats · Oct 19, 2021 · 16ceda5 · 16ceda5
1 parent 9084869
commit 16ceda5
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git a/docs/src/whiten.md b/docs/src/whiten.md
@@ -22,7 +22,7 @@ Whitening transformation can be fitted to data using the `fit` method.
 
 ```@docs
 fit(::Type{Whitening}, X::AbstractMatrix{T}; kwargs...) where {T<:Real}
-transform(::Whitening, ::AbstractVecOrMat)
+MultivariateStats.transform(::Whitening, ::AbstractVecOrMat{<:Real})
 length(::Whitening)
 mean(::Whitening)
 size(::Whitening)

diff --git a/src/whiten.jl b/src/whiten.jl
@@ -74,9 +74,9 @@ size(f::Whitening) = size(f.W)
 
 Get the mean vector of the whitening transformation `f`.
 
-**Note:** if mean is empty, this function returns a zero vector of length [`outdim`](@ref) .
+**Note:** if mean is empty, this function returns a zero vector of `length(f)`.
 """
-mean(f::Whitening) = fullmean(indim(f), f.mean)
+mean(f::Whitening) = fullmean(length(f), f.mean)
 
 
 """
@@ -102,7 +102,7 @@ function transform(f::Whitening, x::AbstractVecOrMat{<:Real})
 end
 
 """
-    fit(::Type{Whitening},  X::AbstractMatrix{T}; kwargs...)
+    fit(Whitening, X::AbstractMatrix{T}; kwargs...)
 
 Estimate a whitening transform from the data given in `X`.