Skip to content

Commit

Permalink
Update enum values in comments (QuantConnect#6460)
Browse files Browse the repository at this point in the history
  • Loading branch information
LouisSzeto authored Jul 5, 2022
1 parent b426483 commit c1db232
Show file tree
Hide file tree
Showing 30 changed files with 301 additions and 299 deletions.
6 changes: 3 additions & 3 deletions Algorithm/Portfolio/PortfolioBias.cs
Original file line number Diff line number Diff line change
Expand Up @@ -21,17 +21,17 @@ namespace QuantConnect.Algorithm.Framework.Portfolio
public enum PortfolioBias
{
/// <summary>
/// Portfolio can only have short positions
/// Portfolio can only have short positions (-1)
/// </summary>
Short = -1,

/// <summary>
/// Portfolio can have both long and short positions
/// Portfolio can have both long and short positions (0)
/// </summary>
LongShort = 0,

/// <summary>
/// Portfolio can only have long positions
/// Portfolio can only have long positions (1)
/// </summary>
Long = 1
}
Expand Down
6 changes: 3 additions & 3 deletions Common/Algorithm/Framework/Alphas/InsightDirection.cs
Original file line number Diff line number Diff line change
Expand Up @@ -25,17 +25,17 @@ namespace QuantConnect.Algorithm.Framework.Alphas
public enum InsightDirection
{
/// <summary>
/// The value will go down
/// The value will go down (-1)
/// </summary>
Down = -1,

/// <summary>
/// The value will stay flat
/// The value will stay flat (0)
/// </summary>
Flat = 0,

/// <summary>
/// The value will go up
/// The value will go up (1)
/// </summary>
Up = 1
}
Expand Down
4 changes: 2 additions & 2 deletions Common/Algorithm/Framework/Alphas/InsightScoreType.cs
Original file line number Diff line number Diff line change
Expand Up @@ -26,12 +26,12 @@ namespace QuantConnect.Algorithm.Framework.Alphas
public enum InsightScoreType
{
/// <summary>
/// Directional accuracy
/// Directional accuracy (0)
/// </summary>
Direction,

/// <summary>
/// Magnitude accuracy
/// Magnitude accuracy (1)
/// </summary>
Magnitude
}
Expand Down
4 changes: 2 additions & 2 deletions Common/Algorithm/Framework/Alphas/InsightType.cs
Original file line number Diff line number Diff line change
Expand Up @@ -25,12 +25,12 @@ namespace QuantConnect.Algorithm.Framework.Alphas
public enum InsightType
{
/// <summary>
/// The insight is for a security's price
/// The insight is for a security's price (0)
/// </summary>
Price,

/// <summary>
/// The insight is for a security's price volatility
/// The insight is for a security's price volatility (1)
/// </summary>
Volatility
}
Expand Down
10 changes: 5 additions & 5 deletions Common/Brokerages/BrokerageMessageType.cs
Original file line number Diff line number Diff line change
Expand Up @@ -21,27 +21,27 @@ namespace QuantConnect.Brokerages
public enum BrokerageMessageType
{
/// <summary>
/// Informational message
/// Informational message (0)
/// </summary>
Information,

/// <summary>
/// Warning message
/// Warning message (1)
/// </summary>
Warning,

/// <summary>
/// Fatal error message, the algo will be stopped
/// Fatal error message, the algo will be stopped (2)
/// </summary>
Error,

/// <summary>
/// Brokerage reconnected with remote server
/// Brokerage reconnected with remote server (3)
/// </summary>
Reconnect,

/// <summary>
/// Brokerage disconnected from remote server
/// Brokerage disconnected from remote server (4)
/// </summary>
Disconnect
}
Expand Down
4 changes: 2 additions & 2 deletions Common/Chart.cs
Original file line number Diff line number Diff line change
Expand Up @@ -154,9 +154,9 @@ public Chart Clone()
/// </summary>
public enum ChartType
{
/// Overlayed stacked
/// Overlayed stacked (0)
Overlay,
/// Stacked series on top of each other.
/// Stacked series on top of each other. (1)
Stacked
}
}
12 changes: 6 additions & 6 deletions Common/Data/FileFormat.cs
Original file line number Diff line number Diff line change
Expand Up @@ -21,35 +21,35 @@ namespace QuantConnect.Data
public enum FileFormat
{
/// <summary>
/// Comma separated values
/// Comma separated values (0)
/// </summary>
Csv,

/// <summary>
/// Binary file data
/// Binary file data (1)
/// </summary>
Binary,

/// <summary>
/// Only the zip entry names are read in as symbols
/// Only the zip entry names are read in as symbols (2)
/// </summary>
ZipEntryName,

/// <summary>
/// Reader returns a BaseDataCollection object.
/// Reader returns a BaseDataCollection object (3)
/// </summary>
/// <remarks>Lean will unfold the collection and consume it as individual data points</remarks>
UnfoldingCollection,

/// <summary>
/// Data stored using an intermediate index source
/// Data stored using an intermediate index source (4)
/// </summary>
Index,

/// <summary>
/// Data type inherits from BaseDataCollection.
/// Reader method can return a non BaseDataCollection type which will be folded, based on unique time,
/// into an instance of the data type.
/// into an instance of the data type (5)
/// </summary>
FoldingCollection
}
Expand Down
6 changes: 3 additions & 3 deletions Common/Data/Market/BarDirection.cs
Original file line number Diff line number Diff line change
Expand Up @@ -21,17 +21,17 @@ namespace QuantConnect.Data.Market
public enum BarDirection
{
/// <summary>
/// Rising bar
/// Rising bar (0)
/// </summary>
Rising,

/// <summary>
/// No change
/// No change (1)
/// </summary>
NoDelta,

/// <summary>
/// Falling bar
/// Falling bar (2)
/// </summary>
Falling
}
Expand Down
2 changes: 2 additions & 0 deletions Common/Data/Market/RenkoType.cs
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ public enum RenkoType
/// - It only returns a single bar, at most, irrespective of tick movement
/// - It will emit consecutive bars side by side
/// - By default even bars are created
/// (0)
/// </summary>
/// <remarks>the Classic mode has only been retained for
/// backwards compatibility with existing code.</remarks>
Expand All @@ -41,6 +42,7 @@ public enum RenkoType
/// - returns zero or more bars per tick, as appropriate.
/// - Will not emit consecutive bars side by side
/// - Creates
/// (1)
/// </summary>
Wicked
}
Expand Down
Loading

0 comments on commit c1db232

Please sign in to comment.