added doc

neurallayer · Jul 6, 2023 · 9958188 · 9958188
1 parent 68f5a20
commit 9958188
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 2 deletions.
diff --git a/roboquant-jupyter/src/main/kotlin/org/roboquant/jupyter/TimeSeriesChart.kt b/roboquant-jupyter/src/main/kotlin/org/roboquant/jupyter/TimeSeriesChart.kt
@@ -28,7 +28,9 @@ import org.roboquant.common.flatten
 import java.math.BigDecimal
 import java.math.RoundingMode
 
-
+/**
+ * Deprecated, use [TimeSeriesChart] instead
+ */
 @Deprecated("Renamed to TimeSeriesChart", ReplaceWith("TimeSeriesChart", "org.roboquant.jupyter.TimeSeriesChart"))
 typealias MetricChart = TimeSeriesChart
 

diff --git a/roboquant/src/main/kotlin/org/roboquant/common/TimeSpan.kt b/roboquant/src/main/kotlin/org/roboquant/common/TimeSpan.kt
@@ -20,7 +20,9 @@ package org.roboquant.common
 
 import java.time.*
 
-
+/**
+ * Deprecated, use [TimeSpan] instead
+ */
 @Deprecated("Renamed to TimeSpan", ReplaceWith("TimeSpan", "org.roboquant.common.TimeSpan"))
 typealias TradingPeriod = TimeSpan