Skip to content

Commit

Permalink
Add 'See also' in docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
eliascarv committed Apr 23, 2022
1 parent e3c8933 commit f243cdb
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion src/transforms/eigenanalysis.jl
Original file line number Diff line number Diff line change
Expand Up @@ -149,6 +149,8 @@ end
The PCA transform is a shortcut for
`ZScore() → EigenAnalysis(:V)`.
See also: [`ZScore`](@ref), [`EigenAnalysis`](@ref).
"""
PCA() = ZScore() EigenAnalysis(:V)

Expand All @@ -157,6 +159,8 @@ PCA() = ZScore() → EigenAnalysis(:V)
The DRS transform is a shortcut for
`ZScore() → EigenAnalysis(:VD)`.
See also: [`ZScore`](@ref), [`EigenAnalysis`](@ref).
"""
DRS() = ZScore() EigenAnalysis(:VD)

Expand All @@ -165,5 +169,7 @@ DRS() = ZScore() → EigenAnalysis(:VD)
The SDS transform is a shortcut for
`ZScore() → EigenAnalysis(:VDV)`.
See also: [`ZScore`](@ref), [`EigenAnalysis`](@ref).
"""
SDS() = ZScore() EigenAnalysis(:VDV)
SDS() = ZScore() EigenAnalysis(:VDV)

0 comments on commit f243cdb

Please sign in to comment.