chore: update docs (#516)

.github/ISSUE_TEMPLATE/bug_report.md

@@ -4,10 +4,9 @@ about: Create a report to help us improve
 title: ''
 labels: bug
 assignees: ''
-
 ---
 
-## The problem
+## the problem
 
 A clear and concise description of the bug.  If known, explain why you believe the problem is within this library.
 
@@ -17,15 +16,15 @@ Error message(s):
 # Include any error messages if available.
 ```
 
-## To Reproduce
+## to reproduce
 
 1. What indicator and parameter arguments were used?
 2. Attach the historical quotes you used (as CSV or Excel file)
 
-## Expected behavior
+## expected behavior
 
-A clear and concise description of what you expected to happen.
+A description of what you expected to happen.
 
-## Screenshots or other reference materials
+## screenshots or other reference materials
 
 If applicable, add screenshots or other reference materials to help explain the problem.

GemFile.lock

@@ -26,7 +26,7 @@ GEM
       ffi (>= 1.15.0)
     eventmachine (1.2.7-x64-mingw32)
     execjs (2.8.1)
-    faraday (1.6.0)
+    faraday (1.7.0)
       faraday-em_http (~> 1.0)
       faraday-em_synchrony (~> 1.0)
       faraday-excon (~> 1.1)
@@ -228,7 +228,7 @@ GEM
       jekyll-seo-tag (~> 2.1)
     minitest (5.14.4)
     multipart-post (2.1.1)
-    nokogiri (1.12.2-x64-mingw32)
+    nokogiri (1.12.3-x64-mingw32)
       racc (~> 1.4)
     octokit (4.21.0)
       faraday (>= 0.9)

indicators/Adl/README.md

@@ -33,7 +33,9 @@ You must have at least two historical quotes; however, since this is a trendline
 IEnumerable<AdlResult>
 ```
 
-We always return the same number of elements as there are in the historical quotes.
+- This method returns a time series of all available indicator values for the `quotes` provided.
+- It always returns the same number of elements as there are in the historical quotes.
+- It does not return a single incremental indicator value.
 
 ### AdlResult
 

indicators/Adx/README.md

@@ -29,9 +29,12 @@ You must have at least `2×N+100` periods of `quotes` to allow for smoothing con
 IEnumerable<AdxResult>
 ```
 
-The first `2×N-1` periods will have `null` values for ADX since there's not enough data to calculate.  We always return the same number of elements as there are in the historical quotes.
+- This method returns a time series of all available indicator values for the `quotes` provided.
+- It always returns the same number of elements as there are in the historical quotes.
+- It does not return a single incremental indicator value.
+- The first `2×N-1` periods will have `null` values for `Adx` since there's not enough data to calculate.
 
-:warning: **Warning**: The first `2×N+100` periods will have decreasing magnitude, convergence-related precision errors that can be as high as ~5% deviation in indicator values for earlier periods.
+:hourglass: **Convergence Warning**: The first `2×N+100` periods will have decreasing magnitude, convergence-related precision errors that can be as high as ~5% deviation in indicator values for earlier periods.
 
 ### AdxResult
 

indicators/Alligator/README.md

@@ -33,9 +33,12 @@ This indicator uses fixed interal parameters for the three moving averages of me
 IEnumerable<AlligatorResult>
 ```
 
-The first 10-20 periods will have `null` values since there's not enough data to calculate.  We always return the same number of elements as there are in the historical quotes.
+- This method returns a time series of all available indicator values for the `quotes` provided.
+- It always returns the same number of elements as there are in the historical quotes.
+- It does not return a single incremental indicator value.
+- The first 10-20 periods will have `null` values since there's not enough data to calculate.
 
-:warning: **Warning**: The first 150 periods will have decreasing magnitude, convergence-related precision errors that can be as high as ~5% deviation in indicator values for earlier periods.
+:hourglass: **Convergence Warning**: The first 150 periods will have decreasing magnitude, convergence-related precision errors that can be as high as ~5% deviation in indicator values for earlier periods.
 
 ### AlligatorResult
 

indicators/Alma/README.md

@@ -31,7 +31,10 @@ You must have at least `N` periods of `quotes`.
 IEnumerable<AlmaResult>
 ```
 
-The first `N-1` periods will have `null` values since there's not enough data to calculate.  We always return the same number of elements as there are in the historical quotes.
+- This method returns a time series of all available indicator values for the `quotes` provided.
+- It always returns the same number of elements as there are in the historical quotes.
+- It does not return a single incremental indicator value.
+- The first `N-1` periods will have `null` values since there's not enough data to calculate.
 
 ### AlmaResult
 

indicators/Aroon/README.md

@@ -29,7 +29,10 @@ You must have at least `N` periods of `quotes`.
 IEnumerable<AroonResult>
 ```
 
-The first `N-1` periods will have `null` Aroon values since there's not enough data to calculate.  We always return the same number of elements as there are in the historical quotes.
+- This method returns a time series of all available indicator values for the `quotes` provided.
+- It always returns the same number of elements as there are in the historical quotes.
+- It does not return a single incremental indicator value.
+- The first `N-1` periods will have `null` values for `Aroon` since there's not enough data to calculate.
 
 ### AroonResult
 

indicators/Atr/README.md

@@ -29,9 +29,12 @@ You must have at least `N+100` periods of `quotes`.  Since this uses a smoothing
 IEnumerable<AtrResult>
 ```
 
-The first `N-1` periods will have `null` values for ATR since there's not enough data to calculate.  We always return the same number of elements as there are in the historical quotes.
+- This method returns a time series of all available indicator values for the `quotes` provided.
+- It always returns the same number of elements as there are in the historical quotes.
+- It does not return a single incremental indicator value.
+- The first `N-1` periods will have `null` values for ATR since there's not enough data to calculate.
 
-:warning: **Warning**: The first `N+100` periods will have decreasing magnitude, convergence-related precision errors that can be as high as ~5% deviation in indicator values for earlier periods.
+:hourglass: **Convergence Warning**: The first `N+100` periods will have decreasing magnitude, convergence-related precision errors that can be as high as ~5% deviation in indicator values for earlier periods.
 
 ### AtrResult
 

indicators/Awesome/README.md

@@ -30,7 +30,10 @@ You must have at least `S` periods of `quotes`.
 IEnumerable<AwesomeResult>
 ```
 
-The first period `S-1` periods will have `null` values since there's not enough data to calculate.  We always return the same number of elements as there are in the historical quotes.
+- This method returns a time series of all available indicator values for the `quotes` provided.
+- It always returns the same number of elements as there are in the historical quotes.
+- It does not return a single incremental indicator value.
+- The first period `S-1` periods will have `null` values since there's not enough data to calculate.
 
 ### AwesomeResult
 

indicators/Beta/README.md

@@ -29,7 +29,10 @@ You must have at least `N` periods of quotes.  You must have at least the same m
 IEnumerable<BetaResult>
 ```
 
-The first `N-1` periods will have `null` values since there's not enough data to calculate.  We always return the same number of elements as there are in the historical quotes.
+- This method returns a time series of all available indicator values for the `quotes` provided.
+- It always returns the same number of elements as there are in the historical quotes.
+- It does not return a single incremental indicator value.
+- The first `N-1` periods will have `null` values since there's not enough data to calculate.
 
 ### BetaResult
 

indicators/BollingerBands/README.md

@@ -30,7 +30,10 @@ You must have at least `N` periods of `quotes`.
 IEnumerable<BollingerBandsResult>
 ```
 
-The first `N-1` periods will have `null` values since there's not enough data to calculate.  We always return the same number of elements as there are in the historical quotes.
+- This method returns a time series of all available indicator values for the `quotes` provided.
+- It always returns the same number of elements as there are in the historical quotes.
+- It does not return a single incremental indicator value.
+- The first `N-1` periods will have `null` values since there's not enough data to calculate.
 
 ### BollingerBandsResult
 

indicators/Bop/README.md

@@ -29,7 +29,10 @@ You must have at least `N` periods of `quotes`.
 IEnumerable<BopResult>
 ```
 
-The first `N-1` periods will have `null` values since there's not enough data to calculate.  We always return the same number of elements as there are in the historical quotes.
+- This method returns a time series of all available indicator values for the `quotes` provided.
+- It always returns the same number of elements as there are in the historical quotes.
+- It does not return a single incremental indicator value.
+- The first `N-1` periods will have `null` values since there's not enough data to calculate.
 
 ### BopResult
 

indicators/Cci/README.md

@@ -29,7 +29,10 @@ You must have at least `N+1` periods of `quotes`.
 IEnumerable<CciResult>
 ```
 
-The first `N-1` periods will have `null` values since there's not enough data to calculate.  We always return the same number of elements as there are in the historical quotes.
+- This method returns a time series of all available indicator values for the `quotes` provided.
+- It always returns the same number of elements as there are in the historical quotes.
+- It does not return a single incremental indicator value.
+- The first `N-1` periods will have `null` values since there's not enough data to calculate.
 
 ### CciResult
 

indicators/ChaikinOsc/README.md

@@ -30,9 +30,12 @@ You must have at least `2×S` or `S+100` periods of `quotes`, whichever is more.
 IEnumerable<ChaikinOscResult>
 ```
 
-The first `S-1` periods will have `null` values for `Oscillator` since there's not enough data to calculate.  We always return the same number of elements as there are in the historical quotes.
+- This method returns a time series of all available indicator values for the `quotes` provided.
+- It always returns the same number of elements as there are in the historical quotes.
+- It does not return a single incremental indicator value.
+- The first `S-1` periods will have `null` values for `Oscillator` since there's not enough data to calculate.
 
-:warning: **Warning**: The first `S+100` periods will have decreasing magnitude, convergence-related precision errors that can be as high as ~5% deviation in indicator values for earlier periods.
+:hourglass: **Convergence Warning**: The first `S+100` periods will have decreasing magnitude, convergence-related precision errors that can be as high as ~5% deviation in indicator values for earlier periods.
 
 ### ChaikinOscResult
 

indicators/Chandelier/README.md

@@ -38,7 +38,10 @@ You must have at least `N+1` periods of `quotes`.
 IEnumerable<ChandelierResult>
 ```
 
-The first `N` periods will have `null` Chandelier values since there's not enough data to calculate.  We always return the same number of elements as there are in the historical quotes.
+- This method returns a time series of all available indicator values for the `quotes` provided.
+- It always returns the same number of elements as there are in the historical quotes.
+- It does not return a single incremental indicator value.
+- The first `N` periods will have `null` Chandelier values since there's not enough data to calculate.
 
 ### ChandelierResult
 

indicators/Chop/README.md

@@ -28,7 +28,10 @@ You must have at least `N+1` periods of `quotes`.
 IEnumerable<ChopResult>
 ```
 
-The first `N` periods will have `null` values since there's not enough data to calculate.  We always return the same number of elements as there are in the historical quotes.
+- This method returns a time series of all available indicator values for the `quotes` provided.
+- It always returns the same number of elements as there are in the historical quotes.
+- It does not return a single incremental indicator value.
+- The first `N` periods will have `null` values since there's not enough data to calculate.
 
 ### ChopResult
 

indicators/Cmf/README.md

@@ -29,7 +29,10 @@ You must have at least `N+1` periods of `quotes`.
 IEnumerable<CmfResult>
 ```
 
-The first `N-1` periods will have `null` values since there's not enough data to calculate.  We always return the same number of elements as there are in the historical quotes.
+- This method returns a time series of all available indicator values for the `quotes` provided.
+- It always returns the same number of elements as there are in the historical quotes.
+- It does not return a single incremental indicator value.
+- The first `N-1` periods will have `null` values since there's not enough data to calculate.
 
 ### CmfResult
 

indicators/ConnorsRsi/README.md

@@ -31,9 +31,12 @@ IEnumerable<ConnorsRsiResult> results =
 IEnumerable<ConnorsRsiResult>
 ```
 
-The first `MAX(R,S,P)-1` periods will have `null` values since there's not enough data to calculate.  We always return the same number of elements as there are in the historical quotes.
+- This method returns a time series of all available indicator values for the `quotes` provided.
+- It always returns the same number of elements as there are in the historical quotes.
+- It does not return a single incremental indicator value.
+- The first `MAX(R,S,P)-1` periods will have `null` values since there's not enough data to calculate.
 
-:warning: **Warning**: The first `N` periods will have decreasing magnitude, convergence-related precision errors that can be as high as ~5% deviation in indicator values for earlier periods.
+:hourglass: **Convergence Warning**: The first `N` periods will have decreasing magnitude, convergence-related precision errors that can be as high as ~5% deviation in indicator values for earlier periods.
 
 ### ConnorsRsiResult
 

indicators/Correlation/README.md

@@ -30,7 +30,10 @@ You must have at least `N` periods for both versions of `quotes`.  Mismatch hist
 IEnumerable<CorrResult>
 ```
 
-The first `N-1` periods will have `null` values since there's not enough data to calculate.  We always return the same number of elements as there are in the historical quotes.
+- This method returns a time series of all available indicator values for the `quotes` provided.
+- It always returns the same number of elements as there are in the historical quotes.
+- It does not return a single incremental indicator value.
+- The first `N-1` periods will have `null` values since there's not enough data to calculate.
 
 ### CorrResult
 

indicators/Donchian/README.md

@@ -29,7 +29,10 @@ You must have at least `N+1` periods of `quotes`.
 IEnumerable<DonchianResult>
 ```
 
-The first `N` periods will have `null` values since there's not enough data to calculate.  We always return the same number of elements as there are in the historical quotes.
+- This method returns a time series of all available indicator values for the `quotes` provided.
+- It always returns the same number of elements as there are in the historical quotes.
+- It does not return a single incremental indicator value.
+- The first `N` periods will have `null` values since there's not enough data to calculate.
 
 ### DonchianResult
 

indicators/ElderRay/README.md

@@ -29,10 +29,12 @@ You must have at least `2×N` or `N+100` periods of `quotes`, whichever is more.
 IEnumerable<ElderRayResult>
 ```
 
-The first `N-1` periods will have `null` indicator values since there's not enough data to calculate.
-We always return the same number of elements as there are in the historical quotes.
+- This method returns a time series of all available indicator values for the `quotes` provided.
+- It always returns the same number of elements as there are in the historical quotes.
+- It does not return a single incremental indicator value.
+- The first `N-1` periods will have `null` indicator values since there's not enough data to calculate.
 
-:warning: **Warning**: The first `N+100` periods will have decreasing magnitude, convergence-related precision errors that can be as high as ~5% deviation in indicator values for earlier periods.
+:hourglass: **Convergence Warning**: The first `N+100` periods will have decreasing magnitude, convergence-related precision errors that can be as high as ~5% deviation in indicator values for earlier periods.
 
 ### ElderRayResult
 

indicators/Ema/README.md

@@ -43,15 +43,14 @@ IEnumerable<DemaResult>
 IEnumerable<TemaResult>
 ```
 
-We always return the same number of elements as there are in the historical quotes.
-
-Standard EMA: The first `N-1` periods will have `null` values since there's not enough data to calculate.
-
-Double EMA: The first `2×N-1` periods will have `null` values since there's not enough data to calculate.
-
-Triple EMA: The first `3×N-2` periods will have `null` values since there's not enough data to calculate.  Also note that we are using the proper [weighted variant](https://en.wikipedia.org/wiki/Triple_exponential_moving_average) for TEMA.  If you prefer the unweighted raw 3 EMAs value, please use the `Ema3` output from the [TRIX](../Trix/README.md) oscillator instead.
-
-:warning: **Warning**: The first respective `N+100`, `2×N+100`, and `3×N+100` periods will have decreasing magnitude, convergence-related precision errors that can be as high as ~5% deviation in indicator values for earlier periods.
+- This method returns a time series of all available indicator values for the `quotes` provided.
+- It always returns the same number of elements as there are in the historical quotes.
+- It does not return a single incremental indicator value.
+- Standard EMA: The first `N-1` periods will have `null` values since there's not enough data to calculate.
+- Double EMA: The first `2×N-1` periods will have `null` values since there's not enough data to calculate.
+- Triple EMA: The first `3×N-2` periods will have `null` values since there's not enough data to calculate.  Also note that we are using the proper [weighted variant](https://en.wikipedia.org/wiki/Triple_exponential_moving_average) for TEMA.  If you prefer the unweighted raw 3 EMAs value, please use the `Ema3` output from the [TRIX](../Trix/README.md) oscillator instead.
+
+:hourglass: **Convergence Warning**: The first respective `N+100`, `2×N+100`, and `3×N+100` periods will have decreasing magnitude, convergence-related precision errors that can be as high as ~5% deviation in indicator values for earlier periods.
 
 ### EmaResult / DemaResult / TemaResult
 

indicators/Epma/README.md

@@ -29,7 +29,10 @@ You must have at least `N` periods of `quotes`.
 IEnumerable<EpmaResult>
 ```
 
-The first `N-1` periods will have `null` values since there's not enough data to calculate.  We always return the same number of elements as there are in the historical quotes.
+- This method returns a time series of all available indicator values for the `quotes` provided.
+- It always returns the same number of elements as there are in the historical quotes.
+- It does not return a single incremental indicator value.
+- The first `N-1` periods will have `null` values since there's not enough data to calculate.
 
 ### EpmaResult
 

indicators/Fcb/README.md

@@ -31,8 +31,10 @@ You must have at least `2×S+1` periods of `quotes`; however, more is typically
 IEnumerable<FcbResult>
 ```
 
-The periods before the first fractal are `null` since they cannot be calculated.
-We always return the same number of elements as there are in the historical quotes.
+- This method returns a time series of all available indicator values for the `quotes` provided.
+- It always returns the same number of elements as there are in the historical quotes.
+- It does not return a single incremental indicator value.
+- The periods before the first fractal are `null` since they cannot be calculated.
 
 ### FcbResult