rename Candle class (#739)

DaveSkender · Mar 6, 2022 · 57cd86d · 57cd86d
1 parent 457cdb2
commit 57cd86d
Show file tree

Hide file tree

Showing 4 changed files with 5 additions and 5 deletions.
diff --git a/docs/_includes/candle-result.md b/docs/_includes/candle-result.md
@@ -5,4 +5,4 @@
 | `Date` | DateTime | Date
 | `Price` | decimal | Price of the most relevant OHLC candle element when a signal is present
 | `Signal` | [Signal]({{site.baseurl}}/guide/#signal) | Generated signal type
-| `Candle` | [Candle]({{site.baseurl}}/guide/#candle) | Candle properties
+| `Candle` | [CandleProperties]({{site.baseurl}}/guide/#candle) | Candle properties
diff --git a/docs/guide.md b/docs/guide.md
@@ -266,7 +266,7 @@ When a candlestick pattern is recognized, it produces a signal.  In some cases,
 
 ### Candle
 
-The `Candle` class is an extended version of `Quote`, and contains additional calculated properties.
+The `CandleProperties` class is an extended version of `Quote`, and contains additional calculated properties.
 
 | name | type | notes
 | -- |-- |--

diff --git a/src/_common/Candles/Candles.cs b/src/_common/Candles/Candles.cs
@@ -20,7 +20,7 @@ internal static List<CandleResult> ConvertToCandleResults<TQuote>(
             {
                 Date = x.Date,
                 Signal = Signal.None,
-                Candle = new Candle
+                Candle = new CandleProperties
                 {
                     Date = x.Date,
                     Open = x.Open,

diff --git a/src/_common/Candles/Models.cs b/src/_common/Candles/Models.cs
@@ -4,7 +4,7 @@ namespace Skender.Stock.Indicators;
 // CANDLESTICK MODELS
 
 [Serializable]
-public class Candle : Quote
+public class CandleProperties : Quote
 {
     // raw sizes
     internal decimal Size => High - Low;
@@ -27,5 +27,5 @@ public class CandleResult : ResultBase
 {
     public decimal? Price { get; set; }
     public Signal Signal { get; set; }
-    public Candle Candle { get; set; }
+    public CandleProperties Candle { get; set; }
 }