Skip to content

Commit 9d464c0

Browse files
authored
Update StandardDeviation docs (#9464)
1 parent 6035c1c commit 9d464c0

2 files changed

Lines changed: 10 additions & 2 deletions

File tree

Algorithm/QCAlgorithm.Indicators.cs

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2244,7 +2244,11 @@ public SmoothedOnBalanceVolume SOBV(Symbol symbol, int period, MovingAverageType
22442244
}
22452245

22462246
/// <summary>
2247-
/// Creates a new StandardDeviation indicator. This will return the population standard deviation of samples over the specified period.
2247+
/// Creates a new StandardDeviation indicator. This will return the population standard
2248+
/// deviation of samples over the specified period. By default, it consumes the security's
2249+
/// price, so the result is the dispersion of price levels, not the asset's volatility.
2250+
/// To compute volatility, chain this indicator onto a <see cref="LOGR"/> or
2251+
/// <see cref="ROC"/> indicator using <see cref="IndicatorExtensions.Of"/>.
22482252
/// </summary>
22492253
/// <param name="symbol">The symbol whose STD we want</param>
22502254
/// <param name="period">The period over which to compute the STD</param>

Indicators/StandardDeviation.cs

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,11 @@
1818
namespace QuantConnect.Indicators
1919
{
2020
/// <summary>
21-
/// This indicator computes the n-period population standard deviation.
21+
/// This indicator computes the n-period population standard deviation of its input.
22+
/// When the input is a price series, the result is the dispersion of price levels, not
23+
/// the asset's volatility. To compute volatility, chain this indicator onto a
24+
/// <see cref="LogReturn"/> or <see cref="RateOfChange"/> indicator using
25+
/// <see cref="IndicatorExtensions.Of"/>.
2226
/// </summary>
2327
public class StandardDeviation : Variance
2428
{

0 commit comments

Comments
 (0)