chore: update docs (#838)

DaveSkender · Jul 3, 2022 · a897923 · a897923
1 parent 77502b9
commit a897923
Show file tree

Hide file tree

Showing 49 changed files with 64 additions and 60 deletions.
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -68,6 +68,7 @@
     "Hutson",
     "Ichimoku",
     "intraday",
+    "jemoji",
     "Kaby",
     "Keltner",
     "kijun",
@@ -81,6 +82,7 @@
     "lookback",
     "Loukas",
     "LSMA",
+    "LWMA",
     "Macd",
     "Mape",
     "Markowitz",
@@ -116,6 +118,7 @@
     "Vitali",
     "Vwap",
     "Vwma",
+    "webp",
     "Woodie"
   ],
   "cSpell.ignorePaths": [

diff --git a/docs/GemFile.lock b/docs/GemFile.lock
@@ -224,7 +224,7 @@ GEM
     minitest (5.16.1)
     nokogiri (1.13.6-x64-mingw32)
       racc (~> 1.4)
-    octokit (4.25.0)
+    octokit (4.25.1)
       faraday (>= 1, < 3)
       sawyer (~> 0.9)
     parallel (1.22.1)

diff --git a/docs/README.md b/docs/README.md
@@ -12,6 +12,7 @@ Explore more information:
 
 - [Indicators and overlays]({{site.baseurl}}/indicators/#content)
 - [Guide and Pro tips]({{site.baseurl}}/guide/#content)
+- [Utilities and Helper functions]({{site.baseurl}}/utilities/#content)
 - [Demo site](https://stock-charts.azurewebsites.net) (a stock chart)
 - [Example usage code]({{site.baseurl}}/examples/#content)
 - [Release notes]({{site.github.repository_url}}/releases)
@@ -20,7 +21,7 @@ Explore more information:
 
 ## Samples
 
-![image](examples.png)
+![image](examples.webp)
 
 ### Basic usage
 

diff --git a/docs/_indicators/Alma.md b/docs/_indicators/Alma.md
@@ -7,7 +7,7 @@ layout: indicator
 
 # {{ page.title }}
 
-Created by Arnaud Legoux and Dimitrios Kouzis-Loukas, [ALMA]({{site.github.repository_url}}/files/5654531/ALMA-Arnaud-Legoux-Moving-Average.pdf) is a Gaussian distribution weighted moving average of Close price.
+Created by Arnaud Legoux and Dimitrios Kouzis-Loukas, [ALMA]({{site.github.repository_url}}/files/5654531/ALMA-Arnaud-Legoux-Moving-Average.pdf) is a Gaussian distribution weighted moving average of price.
 [[Discuss] :speech_balloon:]({{site.github.repository_url}}/discussions/209 "Community discussion about this indicator")
 
 ![image]({{site.baseurl}}/assets/charts/Alma.png)

diff --git a/docs/_indicators/Atr.md b/docs/_indicators/Atr.md
@@ -50,7 +50,7 @@ IEnumerable<AtrResult>
 | `Date` | DateTime | Date
 | `Tr` | double | True Range for current period
 | `Atr` | double | Average True Range for `N` lookback periods
-| `Atrp` | double | Average True Range Percent is `(ATR/Close Price)*100`.  This normalizes so it can be compared to other stocks.
+| `Atrp` | double | Average True Range Percent is `(ATR/Price)*100`.  This normalizes so it can be compared to other stocks.
 
 ### Utilities
 

diff --git a/docs/_indicators/BasicQuote.md b/docs/_indicators/BasicQuote.md
@@ -52,7 +52,7 @@ IEnumerable<BasicData>
 
 See [Utilities and Helpers]({{site.baseurl}}/utilities#utilities-for-indicator-results) for more information.
 
-### Chaining
+## Chaining
 
 Results can be further processed on `Value` with additional chain-enabled indicators.
 

diff --git a/docs/_indicators/BollingerBands.md b/docs/_indicators/BollingerBands.md
@@ -7,7 +7,7 @@ layout: indicator
 
 # {{ page.title }}
 
-Created by John Bollinger, [Bollinger Bands](https://en.wikipedia.org/wiki/Bollinger_Bands) depict volatility as standard deviation boundary lines from a moving average of Close price.  Bollinger Bands&#174; is a registered trademark of John A. Bollinger.
+Created by John Bollinger, [Bollinger Bands](https://en.wikipedia.org/wiki/Bollinger_Bands) depict volatility as standard deviation boundary lines from a moving average of price.  Bollinger Bands&#174; is a registered trademark of John A. Bollinger.
 [[Discuss] :speech_balloon:]({{site.github.repository_url}}/discussions/267 "Community discussion about this indicator")
 
 ![image]({{site.baseurl}}/assets/charts/BollingerBands.png)
@@ -47,11 +47,11 @@ IEnumerable<BollingerBandsResult>
 | name | type | notes
 | -- |-- |--
 | `Date` | DateTime | Date
-| `Sma` | double | Simple moving average (SMA) of Close price (center line)
+| `Sma` | double | Simple moving average (SMA) of price (center line)
 | `UpperBand` | double | Upper line is `D` standard deviations above the SMA
 | `LowerBand` | double | Lower line is `D` standard deviations below the SMA
 | `PercentB` | double | `%B` is the location within the bands.  `(Price-LowerBand)/(UpperBand-LowerBand)`
-| `ZScore` | double | Z-Score of current Close price (number of standard deviations from mean)
+| `ZScore` | double | Z-Score of current price (number of standard deviations from mean)
 | `Width` | double | Width as percent of SMA price.  `(UpperBand-LowerBand)/Sma`
 
 ### Utilities

diff --git a/docs/_indicators/ConnorsRsi.md b/docs/_indicators/ConnorsRsi.md
@@ -22,7 +22,7 @@ IEnumerable<ConnorsRsiResult> results =
 
 | name | type | notes
 | -- |-- |--
-| `rsiPeriods` | int | Lookback period (`R`) for the close price RSI.  Must be greater than 1.  Default is 3.
+| `rsiPeriods` | int | Lookback period (`R`) for the price RSI.  Must be greater than 1.  Default is 3.
 | `streakPeriods` | int | Lookback period (`S`) for the streak RSI.  Must be greater than 1.  Default is 2.
 | `rankPeriods` | int | Lookback period (`P`) for the Percentile Rank.  Must be greater than 1.  Default is 100.
 

diff --git a/docs/_indicators/Correlation.md b/docs/_indicators/Correlation.md
@@ -8,7 +8,7 @@ layout: indicator
 
 # {{ page.title }}
 
-Created by Karl Pearson, the [Correlation Coefficient](https://en.wikipedia.org/wiki/Correlation_coefficient) depicts the linear correlation between two quote histories, based on Close price.  R-Squared (R&sup2;), Variance, and Covariance are also output.
+Created by Karl Pearson, the [Correlation Coefficient](https://en.wikipedia.org/wiki/Correlation_coefficient) depicts the linear correlation between two quote histories.  R-Squared (R&sup2;), Variance, and Covariance are also output.
 [[Discuss] :speech_balloon:]({{site.github.repository_url}}/discussions/259 "Community discussion about this indicator")
 
 ![image]({{site.baseurl}}/assets/charts/Correlation.png)

diff --git a/docs/_indicators/Dema.md b/docs/_indicators/Dema.md
@@ -9,7 +9,7 @@ redirect_from:
 
 # {{ page.title }}
 
-Created by Patrick G. Mulloy, the [Double exponential moving average](https://en.wikipedia.org/wiki/Double_exponential_moving_average) is a faster smoothed EMA of the Close price over a lookback window.
+Created by Patrick G. Mulloy, the [Double exponential moving average](https://en.wikipedia.org/wiki/Double_exponential_moving_average) is a faster smoothed EMA of the price over a lookback window.
 [[Discuss] :speech_balloon:]({{site.github.repository_url}}/discussions/807 "Community discussion about this indicator")
 
 ![image]({{site.baseurl}}/assets/charts/Dema.png)

diff --git a/docs/_indicators/ElderRay.md b/docs/_indicators/ElderRay.md
@@ -49,7 +49,7 @@ IEnumerable<ElderRayResult>
 | name | type | notes
 | -- |-- |--
 | `Date` | DateTime | Date
-| `Ema` | double | Exponential moving average of Close price
+| `Ema` | double | Exponential moving average
 | `BullPower` | double | Bull Power
 | `BearPower` | double | Bear Power
 

diff --git a/docs/_indicators/Hma.md b/docs/_indicators/Hma.md
@@ -7,7 +7,7 @@ layout: indicator
 
 # {{ page.title }}
 
-Created by Alan Hull, the [Hull Moving Average](https://alanhull.com/hull-moving-average) is a modified weighted average of `Close` price that reduces lag.
+Created by Alan Hull, the [Hull Moving Average](https://alanhull.com/hull-moving-average) is a modified weighted average of price that reduces lag.
 [[Discuss] :speech_balloon:]({{site.github.repository_url}}/discussions/252 "Community discussion about this indicator")
 
 ![image]({{site.baseurl}}/assets/charts/Hma.png)
@@ -57,7 +57,7 @@ IEnumerable<HmaResult>
 
 See [Utilities and Helpers]({{site.baseurl}}/utilities#utilities-for-indicator-results) for more information.
 
-### Chaining
+## Chaining
 
 This indicator may be generated from any chain-enabled indicator or method.
 

diff --git a/docs/_indicators/Kama.md b/docs/_indicators/Kama.md
@@ -7,7 +7,7 @@ layout: indicator
 
 # {{ page.title }}
 
-Created by Perry Kaufman, [KAMA](https://school.stockcharts.com/doku.php?id=technical_indicators:kaufman_s_adaptive_moving_average) is an volatility adaptive moving average of Close price over configurable lookback periods.
+Created by Perry Kaufman, [KAMA](https://school.stockcharts.com/doku.php?id=technical_indicators:kaufman_s_adaptive_moving_average) is an volatility adaptive moving average of price over configurable lookback periods.
 [[Discuss] :speech_balloon:]({{site.github.repository_url}}/discussions/210 "Community discussion about this indicator")
 
 ![image]({{site.baseurl}}/assets/charts/Kama.png)

diff --git a/docs/_indicators/Keltner.md b/docs/_indicators/Keltner.md
@@ -51,7 +51,7 @@ IEnumerable<KeltnerResult>
 | -- |-- |--
 | `Date` | DateTime | Date
 | `UpperBand` | double | Upper band of Keltner Channel
-| `Centerline` | double | EMA of Close price
+| `Centerline` | double | EMA of price
 | `LowerBand` | double | Lower band of Keltner Channel
 | `Width` | double | Width as percent of Centerline price.  `(UpperBand-LowerBand)/Centerline`
 

diff --git a/docs/_indicators/MaEnvelopes.md b/docs/_indicators/MaEnvelopes.md
@@ -7,7 +7,7 @@ layout: indicator
 
 # {{ page.title }}
 
-[Moving Average Envelopes](https://en.wikipedia.org/wiki/Moving_average_envelope) is a price band overlay that is offset from the moving average of Close price over a lookback window.
+[Moving Average Envelopes](https://en.wikipedia.org/wiki/Moving_average_envelope) is a price band overlay that is offset from the moving average of price over a lookback window.
 [[Discuss] :speech_balloon:]({{site.github.repository_url}}/discussions/288 "Community discussion about this indicator")
 
 ![image]({{site.baseurl}}/assets/charts/MaEnvelopes.png)

diff --git a/docs/_indicators/Prs.md b/docs/_indicators/Prs.md
@@ -7,7 +7,7 @@ layout: indicator
 
 # {{ page.title }}
 
-[Price Relative Strength (PRS)](https://en.wikipedia.org/wiki/Relative_strength), also called Comparative Relative Strength, shows the ratio of two quote histories, based on Close price.  It is often used to compare against a market index or sector ETF.  When using the optional `lookbackPeriods`, this also returns relative percent change over the specified periods.  This is not the same as the more prevalent [Relative Strength Index (RSI)]({{site.baseurl}}/indicators/Rsi/#content).
+[Price Relative Strength (PRS)](https://en.wikipedia.org/wiki/Relative_strength), also called Comparative Relative Strength, shows the ratio of two quote histories, based on price.  It is often used to compare against a market index or sector ETF.  When using the optional `lookbackPeriods`, this also returns relative percent change over the specified periods.  This is not the same as the more prevalent [Relative Strength Index (RSI)]({{site.baseurl}}/indicators/Rsi/#content).
 [[Discuss] :speech_balloon:]({{site.github.repository_url}}/discussions/243 "Community discussion about this indicator")
 
 ![image]({{site.baseurl}}/assets/charts/Prs.png)

diff --git a/docs/_indicators/Roc.md b/docs/_indicators/Roc.md
@@ -8,7 +8,7 @@ layout: indicator
 
 # {{ page.title }}
 
-[Rate of Change](https://en.wikipedia.org/wiki/Momentum_(technical_analysis)), also known as Momentum Oscillator, is the percent change of Close price over a lookback window.  A [Rate of Change with Bands]({{site.baseurl}}/indicators/RocWb/#content) variant, created by Vitali Apirine, is also included.
+[Rate of Change](https://en.wikipedia.org/wiki/Momentum_(technical_analysis)), also known as Momentum Oscillator, is the percent change of price over a lookback window.  A [Rate of Change with Bands]({{site.baseurl}}/indicators/RocWb/#content) variant, created by Vitali Apirine, is also included.
 [[Discuss] :speech_balloon:]({{site.github.repository_url}}/discussions/242 "Community discussion about this indicator")
 
 ![image]({{site.baseurl}}/assets/charts/Roc.png)

diff --git a/docs/_indicators/Slope.md b/docs/_indicators/Slope.md
@@ -49,9 +49,9 @@ IEnumerable<SlopeResult>
 | name | type | notes
 | -- |-- |--
 | `Date` | DateTime | Date
-| `Slope` | double | Slope `m` of the best-fit line of Close price
+| `Slope` | double | Slope `m` of the best-fit line of price
 | `Intercept` | double | Y-Intercept `b` of the best-fit line
-| `StdDev` | double | Standard Deviation of Close price over `N` lookback periods
+| `StdDev` | double | Standard Deviation of price over `N` lookback periods
 | `RSquared` | double | R-Squared (R&sup2;), aka Coefficient of Determination
 | `Line` | decimal | Best-fit line `y` over the last 'N' periods (i.e. `y=mx+b` using last period values)
 

diff --git a/docs/_indicators/Smma.md b/docs/_indicators/Smma.md
@@ -8,7 +8,7 @@ layout: indicator
 
 # {{ page.title }}
 
-[Smoothed Moving Average](https://en.wikipedia.org/wiki/Moving_average#Modified_moving_average) is the average of Close price over a lookback window using a smoothing method.  SMMA is also known as modified moving average (MMA) and running moving average (RMA).
+[Smoothed Moving Average](https://en.wikipedia.org/wiki/Moving_average#Modified_moving_average) is the average of price over a lookback window using a smoothing method.  SMMA is also known as modified moving average (MMA) and running moving average (RMA).
 [[Discuss] :speech_balloon:]({{site.github.repository_url}}/discussions/375 "Community discussion about this indicator")
 
 ![image]({{site.baseurl}}/assets/charts/Smma.png)

diff --git a/docs/_indicators/StarcBands.md b/docs/_indicators/StarcBands.md
@@ -51,7 +51,7 @@ IEnumerable<StarcBandsResult>
 | -- |-- |--
 | `Date` | DateTime | Date
 | `UpperBand` | decimal | Upper STARC band
-| `Centerline` | decimal | SMA of Close price
+| `Centerline` | decimal | SMA of price
 | `LowerBand` | decimal | Lower STARC band
 
 ### Utilities

diff --git a/docs/_indicators/StdDev.md b/docs/_indicators/StdDev.md
@@ -8,7 +8,7 @@ layout: indicator
 
 # {{ page.title }}
 
-[Standard Deviation](https://en.wikipedia.org/wiki/Standard_deviation) of Close price over a rolling lookback window.  Also known as Historical Volatility (HV).
+[Standard Deviation](https://en.wikipedia.org/wiki/Standard_deviation) of price over a rolling lookback window.  Also known as Historical Volatility (HV).
 [[Discuss] :speech_balloon:]({{site.github.repository_url}}/discussions/239 "Community discussion about this indicator")
 
 ![image]({{site.baseurl}}/assets/charts/StdDev.png)
@@ -52,9 +52,9 @@ IEnumerable<StdDevResult>
 | name | type | notes
 | -- |-- |--
 | `Date` | DateTime | Date
-| `StdDev` | double | Standard Deviation of Close price over `N` lookback periods
-| `Mean` | double | Mean value of Close price over `N` lookback periods
-| `ZScore` | double | Z-Score of current Close price (number of standard deviations from mean)
+| `StdDev` | double | Standard Deviation of price over `N` lookback periods
+| `Mean` | double | Mean value of price over `N` lookback periods
+| `ZScore` | double | Z-Score of current price (number of standard deviations from mean)
 | `StdDevSma` | double | Moving average (SMA) of `StdDev` based on `smaPeriods` periods, if specified
 
 ### Utilities

diff --git a/docs/_indicators/StochRsi.md b/docs/_indicators/StochRsi.md
@@ -53,7 +53,7 @@ IEnumerable<StochRsiResult>
 | name | type | notes
 | -- |-- |--
 | `Date` | DateTime | Date
-| `StochRsi` | double | %K Oscillator = Stochastic RSI = Stoch(`S`,`G`,`M`) of RSI(`R`) of Close price
+| `StochRsi` | double | %K Oscillator = Stochastic RSI = Stoch(`S`,`G`,`M`) of RSI(`R`) of price
 | `Signal` | double | %D Signal Line = Simple moving average of %K based on `G` periods
 
 ### Utilities
@@ -65,7 +65,7 @@ IEnumerable<StochRsiResult>
 
 See [Utilities and Helpers]({{site.baseurl}}/utilities#utilities-for-indicator-results) for more information.
 
-### Chaining
+## Chaining
 
 Results can be further processed on `StochRsi` with additional chain-enabled indicators.
 

diff --git a/docs/_indicators/Tema.md b/docs/_indicators/Tema.md
@@ -9,7 +9,7 @@ redirect_from:
 
 # {{ page.title }}
 
-Created by Patrick G. Mulloy, the [Triple exponential moving average](https://en.wikipedia.org/wiki/Triple_exponential_moving_average) is a faster multi-smoothed EMA of the Close price over a lookback window.
+Created by Patrick G. Mulloy, the [Triple exponential moving average](https://en.wikipedia.org/wiki/Triple_exponential_moving_average) is a faster multi-smoothed EMA of the price over a lookback window.
 Note: TEMA is often confused with the alternative [TRIX]({{site.baseurl}}/indicators/Trix/#content) oscillator.
 [[Discuss] :speech_balloon:]({{site.github.repository_url}}/discussions/808 "Community discussion about this indicator")
 

diff --git a/docs/_indicators/Trix.md b/docs/_indicators/Trix.md
@@ -7,7 +7,7 @@ layout: indicator
 
 # {{ page.title }}
 
-Created by Jack Hutson, [TRIX](https://en.wikipedia.org/wiki/Trix_(technical_analysis)) is the rate of change for a 3 EMA smoothing of the Close price over a lookback window.  TRIX is often confused with [TEMA]({{site.baseurl}}/indicators/Tema/#content).
+Created by Jack Hutson, [TRIX](https://en.wikipedia.org/wiki/Trix_(technical_analysis)) is the rate of change for a 3 EMA smoothing of the price over a lookback window.  TRIX is often confused with [TEMA]({{site.baseurl}}/indicators/Tema/#content).
 [[Discuss] :speech_balloon:]({{site.github.repository_url}}/discussions/234 "Community discussion about this indicator")
 
 ![image]({{site.baseurl}}/assets/charts/Trix.png)
@@ -53,7 +53,7 @@ IEnumerable<TrixResult>
 | name | type | notes
 | -- |-- |--
 | `Date` | DateTime | Date
-| `Ema3` | decimal | 3 EMAs of the Close price
+| `Ema3` | decimal | 3 EMAs of the price
 | `Trix` | decimal | Rate of Change of 3 EMAs
 | `Signal` | decimal | SMA of `Trix` based on `signalPeriods` periods, if specified
 

diff --git a/docs/_indicators/UlcerIndex.md b/docs/_indicators/UlcerIndex.md
@@ -7,7 +7,7 @@ layout: indicator
 
 # {{ page.title }}
 
-Created by Peter Martin, the [Ulcer Index](https://en.wikipedia.org/wiki/Ulcer_index) is a measure of downside Close price volatility over a lookback window.
+Created by Peter Martin, the [Ulcer Index](https://en.wikipedia.org/wiki/Ulcer_index) is a measure of downside price volatility over a lookback window.
 [[Discuss] :speech_balloon:]({{site.github.repository_url}}/discussions/232 "Community discussion about this indicator")
 
 ![image]({{site.baseurl}}/assets/charts/UlcerIndex.png)

diff --git a/docs/_indicators/Vwap.md b/docs/_indicators/Vwap.md
@@ -7,7 +7,7 @@ layout: indicator
 
 # {{ page.title }}
 
-The [Volume Weighted Average Price](https://en.wikipedia.org/wiki/Volume-weighted_average_price) is a Volume weighted average of Close price, typically used on intraday data.
+The [Volume Weighted Average Price](https://en.wikipedia.org/wiki/Volume-weighted_average_price) is a Volume weighted average of price, typically used on intraday data.
 [[Discuss] :speech_balloon:]({{site.github.repository_url}}/discussions/310 "Community discussion about this indicator")
 
 ![image]({{site.baseurl}}/assets/charts/Vwap.png)

diff --git a/docs/contributing.md b/docs/contributing.md
@@ -25,17 +25,18 @@ If you have general interest in contributing, but are not sure where to start, p
 
 If you are reporting a bug or suspect a problem, please [submit an Issue](https://github.com/DaveSkender/Stock.Indicators/issues) with a detailed description of the problem + include steps to reproduce, code samples, and any reference materials.  For new features, add a new Issue with the `enhancement` label.
 
+Use the [Discussions](https://github.com/DaveSkender/Stock.Indicators/discussions) area for general ideation and help/usage questions.
+
 ## Project management
 
 - Planned work is managed in [the backlog](https://github.com/users/DaveSkender/projects/1).
 - Work items are primarily [entered as Notes](https://docs.github.com/en/free-pro-team@latest/github/managing-your-work-on-github/adding-notes-to-a-project-board) (not Issues), except where an issue or feature is user reported.  With that said, Notes can be converted to Issues if in-progress and collaborative discussion is needed.
-- Use the [Discussions](https://github.com/DaveSkender/Stock.Indicators/discussions) area for general ideation and help/usage questions.
 
 ## Developing
 
 - Read this first: [A Step by Step Guide to Making Your First GitHub Contribution](https://codeburst.io/a-step-by-step-guide-to-making-your-first-github-contribution-5302260a2940).  I also have a discussion [on Forking](https://github.com/DaveSkender/Stock.Indicators/discussions/503) if you have questions.
 - If you want to work on something specific, please mention your intention on the related [Issue](https://github.com/DaveSkender/Stock.Indicators/issues).  If an Issue does not exist for your contribution, please create one before starting.  This will help us reserve that feature and avoid duplicative efforts.
-- If you are adding a new indicator, the easiest way to do this is to copy the folder of an existing indicator and rename everything using the same naming conventions and taxonomy.  All new indicators should include unit and performance tests.
+- If you are adding a new indicator, the easiest way to do this is to copy the folder of an existing indicator and rename everything using the same naming conventions and taxonomy.  All new indicators should include [tests](#testing).
 - Do not comingle multiple contributions on different topics.  Please keep changes small and separate.
 
 ## Testing

diff --git a/docs/examples.webp b/docs/examples.webp
diff --git a/docs/examples/README.md b/docs/examples/README.md
@@ -18,7 +18,7 @@ For more information on how to use this library overall, see the [Guide and Pro
 
 To run the sample projects:
 
-1. [Download the ZIP file](Skender.Stock.Indicators-Examples.zip) and extract consents
+1. [Download the ZIP file](Skender.Stock.Indicators-Examples.zip) and extract contents
 2. Open `Examples.sln` in [Visual Studio](https://visualstudio.microsoft.com)
 3. Review the code in the `Program.cs` file
 4. Run the `ConsoleApp` by any one of the following methods: