WIP Doc

femtotrader · Apr 24, 2024 · 98f1e22 · 98f1e22
1 parent 061188e
commit 98f1e22
Show file tree

Hide file tree

Showing 7 changed files with 22 additions and 1 deletion.
diff --git a/src/asset_return.jl b/src/asset_return.jl
@@ -1,5 +1,5 @@
 @doc """
-    S
+    WIP
 """
 mutable struct SimpleAssetReturn{T} <: PortfolioAnalytics{T}
     value::Union{Missing,T}

diff --git a/src/cumulative_return.jl b/src/cumulative_return.jl
@@ -1,3 +1,6 @@
+@doc """
+    WIP
+"""
 mutable struct CumulativeReturn{T} <: PortfolioAnalytics{T}
     value::T
     n::Int

diff --git a/src/drawdowns.jl b/src/drawdowns.jl
@@ -1,3 +1,6 @@
+@doc """
+    WIP
+"""
 mutable struct DrawDowns{T} <: PortfolioAnalytics{T}
     value::T
     n::Int
@@ -22,6 +25,9 @@ function OnlineStatsBase._fit!(stat::DrawDowns, ret)
 end
 
 
+@doc """
+    WIP
+"""
 mutable struct ArithmeticDrawDowns{T} <: PortfolioAnalytics{T}
     value::T
     n::Int

diff --git a/src/mean_return.jl b/src/mean_return.jl
@@ -21,6 +21,9 @@ OnlineStatsBase._merge!(o::T, o2::T) where {T<:Prod} = (o.prod *= o2.prod; o.n +
 
 # https://github.com/joshday/OnlineStatsBase.jl/issues/41
 
+@doc """
+    WIP
+"""
 mutable struct GeometricMeanReturn{T} <: PortfolioAnalytics{T}
     value::T
     n::Int

diff --git a/src/moments.jl b/src/moments.jl
@@ -1,3 +1,6 @@
+@doc """
+    WIP
+"""
 mutable struct AssetReturnMoments{T} <: PortfolioAnalytics{T}
     value::NamedTuple
     n::Int

diff --git a/src/sharpe.jl b/src/sharpe.jl
@@ -1,3 +1,6 @@
+@doc """
+    WIP
+"""
 mutable struct Sharpe{T} <: PortfolioAnalytics{T}
     value::T
     n::Int

diff --git a/src/sortino.jl b/src/sortino.jl
@@ -1,3 +1,6 @@
+@doc """
+    WIP
+"""
 mutable struct Sortino{T} <: PortfolioAnalytics{T}
     value::T
     n::Int
-Original file line number
+Diff line change
@@ Expand Up @@
     # https://github.com/joshday/OnlineStatsBase.jl/issues/41
+    @doc """
+        WIP
+    """
     mutable struct GeometricMeanReturn{T} <: PortfolioAnalytics{T}
         value::T
         n::Int
@@ Expand Down @@