docs: Update example snippet (cosmetic) (#365)

facioquo · Apr 3, 2024 · d549b60 · d549b60
1 parent 76e9eef
commit d549b60
Show file tree

Hide file tree

Showing 80 changed files with 95 additions and 99 deletions.
diff --git a/docs/GemFile.lock b/docs/GemFile.lock
@@ -254,7 +254,7 @@ GEM
     pathutil (0.16.2)
       forwardable-extended (~> 2.6)
     posix-spawn (0.3.15)
-    public_suffix (5.0.4)
+    public_suffix (5.0.5)
     racc (1.7.3)
     rb-fsevent (0.11.2)
     rb-inotify (0.10.1)

diff --git a/docs/_indicators/Adl.md b/docs/_indicators/Adl.md
@@ -59,7 +59,7 @@ See [Utilities and Helpers]({{site.baseurl}}/utilities#utilities-for-indicator-r
 from stock_indicators import indicators
 
 # This method is NOT a part of the library.
-quotes = get_history_from_feed("SPY")
+quotes = get_historical_quotes("SPY")
 
 # calculate
 results = indicators.get_adl(quotes)

diff --git a/docs/_indicators/Adx.md b/docs/_indicators/Adx.md
@@ -60,7 +60,7 @@ See [Utilities and Helpers]({{site.baseurl}}/utilities#utilities-for-indicator-r
 from stock_indicators import indicators
 
 # This method is NOT a part of the library.
-quotes = get_history_from_feed("SPY")
+quotes = get_historical_quotes("SPY")
 
 # calculate 14-period ADX
 results = indicators.get_adx(quotes, lookback_periods)

diff --git a/docs/_indicators/Alligator.md b/docs/_indicators/Alligator.md
@@ -64,7 +64,7 @@ See [Utilities and Helpers]({{site.baseurl}}/utilities#utilities-for-indicator-r
 from stock_indicators import indicators
 
 # This method is NOT a part of the library.
-quotes = get_history_from_feed("SPY")
+quotes = get_historical_quotes("SPY")
 
 # calculate the Williams Alligator
 results = indicators.get_alligator(quotes)

diff --git a/docs/_indicators/Alma.md b/docs/_indicators/Alma.md
@@ -57,7 +57,7 @@ See [Utilities and Helpers]({{site.baseurl}}/utilities#utilities-for-indicator-r
 from stock_indicators import indicators
 
 # This method is NOT a part of the library.
-quotes = get_history_from_feed("SPY")
+quotes = get_historical_quotes("SPY")
 
 # calculate Alma
 results = indicators.get_alma(quotes, 10, 0.5, 6)

diff --git a/docs/_indicators/Aroon.md b/docs/_indicators/Aroon.md
@@ -57,7 +57,7 @@ See [Utilities and Helpers]({{site.baseurl}}/utilities#utilities-for-indicator-r
 from stock_indicators import indicators
 
 # This method is NOT a part of the library.
-quotes = get_history_from_feed("SPY")
+quotes = get_historical_quotes("SPY")
 
 results = indicators.get_aroon(quotes, lookback_periods)
 ```

diff --git a/docs/_indicators/Atr.md b/docs/_indicators/Atr.md
@@ -64,7 +64,7 @@ See [Utilities and Helpers]({{site.baseurl}}/utilities#utilities-for-indicator-r
 from stock_indicators import indicators
 
 # This method is NOT a part of the library.
-quotes = get_history_from_feed("SPY")
+quotes = get_historical_quotes("SPY")
 
 # calculate 14-period ATR
 results = indicators.get_atr(quotes, 14)

diff --git a/docs/_indicators/Awesome.md b/docs/_indicators/Awesome.md
@@ -58,7 +58,7 @@ See [Utilities and Helpers]({{site.baseurl}}/utilities#utilities-for-indicator-r
 from stock_indicators import indicators
 
 # This method is NOT a part of the library.
-quotes = get_history_from_feed("SPY")
+quotes = get_historical_quotes("SPY")
 
 # calculate
 results = indicators.get_awesome(quotes, 5, 34)

diff --git a/docs/_indicators/Beta.md b/docs/_indicators/Beta.md
@@ -76,8 +76,8 @@ from stock_indicators import indicators
 from stock_indicators import BetaType      # Short path, version >= 0.8.1
 
 # This method is NOT a part of the library.
-history_SPX = get_history_from_feed("SPX")
-history_TSLA = get_history_from_feed("TSLA")
+history_SPX = get_historical_quotes("SPX")
+history_TSLA = get_historical_quotes("TSLA")
 
 # calculate 20-period Beta coefficient
 results = indicators.get_beta(history_SPX, history_TSLA, 20, BetaType.STANDARD)

diff --git a/docs/_indicators/BollingerBands.md b/docs/_indicators/BollingerBands.md
@@ -61,7 +61,7 @@ See [Utilities and Helpers]({{site.baseurl}}/utilities#utilities-for-indicator-r
 from stock_indicators import indicators
 
 # This method is NOT a part of the library.
-quotes = get_history_from_feed("SPY")
+quotes = get_historical_quotes("SPY")
 
 # calculate BollingerBands(20, 2)
 results = indicators.get_bollinger_bands(quotes, 20, 2)

diff --git a/docs/_indicators/Bop.md b/docs/_indicators/Bop.md
@@ -56,7 +56,7 @@ See [Utilities and Helpers]({{site.baseurl}}/utilities#utilities-for-indicator-r
 from stock_indicators import indicators
 
 # This method is NOT a part of the library.
-quotes = get_history_from_feed("SPY")
+quotes = get_historical_quotes("SPY")
 
 # Calculate 14-period BOP
 results = indicators.get_bop(quotes, 14)

diff --git a/docs/_indicators/Cci.md b/docs/_indicators/Cci.md
@@ -55,7 +55,7 @@ See [Utilities and Helpers]({{site.baseurl}}/utilities#utilities-for-indicator-r
 from stock_indicators import indicators
 
 # This method is NOT a part of the library.
-quotes = get_history_from_feed("SPY")
+quotes = get_historical_quotes("SPY")
 
 # Calculate 20-period CCI
 results = indicators.get_cci(quotes, 20)

diff --git a/docs/_indicators/ChaikinOsc.md b/docs/_indicators/ChaikinOsc.md
@@ -63,7 +63,7 @@ See [Utilities and Helpers]({{site.baseurl}}/utilities#utilities-for-indicator-r
 from stock_indicators import indicators
 
 # This method is NOT a part of the library.
-quotes = get_history_from_feed("SPY")
+quotes = get_historical_quotes("SPY")
 
 # Calculate 20-period Chaikin Oscillator
 results = indicators.get_chaikin_osc(quotes, 20)

diff --git a/docs/_indicators/Chandelier.md b/docs/_indicators/Chandelier.md
@@ -69,7 +69,7 @@ from stock_indicators import indicators
 from stock_indicators import ChandelierType     # Short path, version >= 0.8.1
 
 # This method is NOT a part of the library.
-quotes = get_history_from_feed("SPY")
+quotes = get_historical_quotes("SPY")
 
 # calculate Chandelier(22,3)
 results = indicators.get_chandelier(quotes, 22, 3, ChandelierType.LONG)

diff --git a/docs/_indicators/Chop.md b/docs/_indicators/Chop.md
@@ -55,7 +55,7 @@ See [Utilities and Helpers]({{site.baseurl}}/utilities#utilities-for-indicator-r
 from stock_indicators import indicators
 
 # This method is NOT a part of the library.
-quotes = get_history_from_feed("SPY")
+quotes = get_historical_quotes("SPY")
 
 # Calculate CHOP(14)
 results = indicators.get_chop(quotes, 14)

diff --git a/docs/_indicators/Cmf.md b/docs/_indicators/Cmf.md
@@ -59,7 +59,7 @@ See [Utilities and Helpers]({{site.baseurl}}/utilities#utilities-for-indicator-r
 from stock_indicators import indicators
 
 # This method is NOT a part of the library.
-quotes = get_history_from_feed("SPY")
+quotes = get_historical_quotes("SPY")
 
 # Calculate 20-period CMF
 results = indicators.get_cmf(quotes, 20)

diff --git a/docs/_indicators/ConnorsRsi.md b/docs/_indicators/ConnorsRsi.md
@@ -62,7 +62,7 @@ See [Utilities and Helpers]({{site.baseurl}}/utilities#utilities-for-indicator-r
 from stock_indicators import indicators
 
 # This method is NOT a part of the library.
-quotes = get_history_from_feed("SPY")
+quotes = get_historical_quotes("SPY")
 
 # Calculate ConnorsRsi(3,2.100)
 results = indicators.get_connors_rsi(quotes, 3, 2, 100)

diff --git a/docs/_indicators/Correlation.md b/docs/_indicators/Correlation.md
@@ -61,8 +61,8 @@ See [Utilities and Helpers]({{site.baseurl}}/utilities#utilities-for-indicator-r
 from stock_indicators import indicators
 
 # This method is NOT a part of the library.
-quotes_spx = get_history_from_feed("SPX")
-quotes_tsla = get_history_from_feed("TSLA")
+quotes_spx = get_historical_quotes("SPX")
+quotes_tsla = get_historical_quotes("TSLA")
 
 # Calculate 20-period Correlation
 results = indicators.get_correlation(quotes_spx, quotes_tsla, 20)

diff --git a/docs/_indicators/Dema.md b/docs/_indicators/Dema.md
@@ -57,7 +57,7 @@ See [Utilities and Helpers]({{site.baseurl}}/utilities#utilities-for-indicator-r
 from stock_indicators import indicators
 
 # This method is NOT a part of the library.
-quotes = get_history_from_feed("SPY")
+quotes = get_historical_quotes("SPY")
 
 # calculate 20-period DEMA
 results = indicators.get_dema(quotes, 20)

diff --git a/docs/_indicators/Doji.md b/docs/_indicators/Doji.md
@@ -52,7 +52,7 @@ See [Utilities and Helpers]({{site.baseurl}}/utilities#utilities-for-indicator-r
 from stock_indicators import indicators
 
 # This method is NOT a part of the library.
-quotes = get_history_from_feed("SPY")
+quotes = get_historical_quotes("SPY")
 
 # Calculate
 results = indicators.get_doji(quotes);

diff --git a/docs/_indicators/Donchian.md b/docs/_indicators/Donchian.md
@@ -59,7 +59,7 @@ See [Utilities and Helpers]({{site.baseurl}}/utilities#utilities-for-indicator-r
 from stock_indicators import indicators
 
 # This method is NOT a part of the library.
-quotes = get_history_from_feed("SPY")
+quotes = get_historical_quotes("SPY")
 
 # calculate Donchian(20)
 results = indicators.get_donchian(quotes, 20)

diff --git a/docs/_indicators/Dpo.md b/docs/_indicators/Dpo.md
@@ -56,7 +56,7 @@ See [Utilities and Helpers]({{site.baseurl}}/utilities#utilities-for-indicator-r
 from stock_indicators import indicators
 
 # This method is NOT a part of the library.
-quotes = get_history_from_feed("SPY")
+quotes = get_historical_quotes("SPY")
 
 # Calculate
 results = indicators.get_dpo(quotes, 14)

diff --git a/docs/_indicators/ElderRay.md b/docs/_indicators/ElderRay.md
@@ -60,7 +60,7 @@ See [Utilities and Helpers]({{site.baseurl}}/utilities#utilities-for-indicator-r
 from stock_indicators import indicators
 
 # This method is NOT a part of the library.
-quotes = get_history_from_feed("SPY")
+quotes = get_historical_quotes("SPY")
 
 # calculate ElderRay(13)
 results = indicators.get_elder_ray(quotes, 13)

diff --git a/docs/_indicators/Ema.md b/docs/_indicators/Ema.md
@@ -61,7 +61,7 @@ from stock_indicators import indicators
 from stock_indicators import CandlePart     # Short path, version >= 0.8.1
 
 # This method is NOT a part of the library.
-quotes = get_history_from_feed("SPY")
+quotes = get_historical_quotes("SPY")
 
 # calculate 20-period EMA
 results = indicators.get_ema(quotes, 20, CandlePart.CLOSE)

diff --git a/docs/_indicators/Epma.md b/docs/_indicators/Epma.md
@@ -56,7 +56,7 @@ See [Utilities and Helpers]({{site.baseurl}}/utilities#utilities-for-indicator-r
 from stock_indicators import indicators
 
 # This method is NOT a part of the library.
-quotes = get_history_from_feed("SPY")
+quotes = get_historical_quotes("SPY")
 
 # Calculate 20-period EPMA
 results = indicators.get_epma(quotes, 20)

diff --git a/docs/_indicators/Fcb.md b/docs/_indicators/Fcb.md
@@ -58,7 +58,7 @@ See [Utilities and Helpers]({{site.baseurl}}/utilities#utilities-for-indicator-r
 from stock_indicators import indicators
 
 # This method is NOT a part of the library.
-quotes = get_history_from_feed("SPY")
+quotes = get_historical_quotes("SPY")
 
 # Calculate Fcb(14)
 results = indicators.get_fcb(quotes, 14)

diff --git a/docs/_indicators/FisherTransform.md b/docs/_indicators/FisherTransform.md
@@ -63,7 +63,7 @@ See [Utilities and Helpers]({{site.baseurl}}/utilities#utilities-for-indicator-r
 from stock_indicators import indicators
 
 # This method is NOT a part of the library.
-quotes = get_history_from_feed("SPY")
+quotes = get_historical_quotes("SPY")
 
 # Calculate 10-period FisherTransform
 results = indicators.get_fisher_transform(quotes, 10)

diff --git a/docs/_indicators/ForceIndex.md b/docs/_indicators/ForceIndex.md
@@ -57,7 +57,7 @@ See [Utilities and Helpers]({{site.baseurl}}/utilities#utilities-for-indicator-r
 from stock_indicators import indicators
 
 # This method is NOT a part of the library.
-quotes = get_history_from_feed("SPY")
+quotes = get_historical_quotes("SPY")
 
 # Calculate ForceIndex(13)
 results = indicators.get_force_index(quotes, 13)

diff --git a/docs/_indicators/Fractal.md b/docs/_indicators/Fractal.md
@@ -75,7 +75,7 @@ See [Utilities and Helpers]({{site.baseurl}}/utilities#utilities-for-indicator-r
 from stock_indicators import indicators
 
 # This method is NOT a part of the library.
-quotes = get_history_from_feed("SPY")
+quotes = get_historical_quotes("SPY")
 
 # calculate Fractal
 results = indicators.get_fractal(quotes, 5)

diff --git a/docs/_indicators/Gator.md b/docs/_indicators/Gator.md
@@ -61,7 +61,7 @@ See [Utilities and Helpers]({{site.baseurl}}/utilities#utilities-for-indicator-r
 from stock_indicators import indicators
 
 # This method is NOT a part of the library.
-quotes = get_history_from_feed("SPY")
+quotes = get_historical_quotes("SPY")
 
 # Calculate the Gator Oscillator
 results = indicators.get_gator(quotes)

diff --git a/docs/_indicators/HeikinAshi.md b/docs/_indicators/HeikinAshi.md
@@ -57,7 +57,7 @@ See [Utilities and Helpers]({{site.baseurl}}/utilities#utilities-for-indicator-r
 from stock_indicators import indicators
 
 # This method is NOT a part of the library.
-quotes = get_history_from_feed("SPY")
+quotes = get_historical_quotes("SPY")
 
 # calculate
 results = indicators.get_heikin_ashi(quotes)

diff --git a/docs/_indicators/Hma.md b/docs/_indicators/Hma.md
@@ -55,7 +55,7 @@ See [Utilities and Helpers]({{site.baseurl}}/utilities#utilities-for-indicator-r
 from stock_indicators import indicators
 
 # This method is NOT a part of the library.
-quotes = get_history_from_feed("SPY")
+quotes = get_historical_quotes("SPY")
 
 # Calculate 20-period HMA
 results = indicators.get_hma(quotes, 20)

diff --git a/docs/_indicators/HtTrendline.md b/docs/_indicators/HtTrendline.md
@@ -59,7 +59,7 @@ See [Utilities and Helpers]({{site.baseurl}}/utilities#utilities-for-indicator-r
 from stock_indicators import indicators
 
 # This method is NOT a part of the library.
-quotes = get_history_from_feed("SPY")
+quotes = get_historical_quotes("SPY")
 
 # Calculate HT Trendline
 results = indicators.get_ht_trendline(quotes)

diff --git a/docs/_indicators/Hurst.md b/docs/_indicators/Hurst.md
@@ -57,7 +57,7 @@ See [Utilities and Helpers]({{site.baseurl}}/utilities#utilities-for-indicator-r
 from stock_indicators import indicators
 
 # This method is NOT a part of the library.
-quotes = get_history_from_feed("SPY")
+quotes = get_historical_quotes("SPY")
 
 # Calculate 20-period Hurst
 results = indicators.get_hurst(quotes, 20)

diff --git a/docs/_indicators/Ichimoku.md b/docs/_indicators/Ichimoku.md
@@ -73,7 +73,7 @@ See [Utilities and Helpers]({{site.baseurl}}/utilities#utilities-for-indicator-r
 from stock_indicators import indicators
 
 # This method is NOT a part of the library.
-quotes = get_history_from_feed("SPY")
+quotes = get_historical_quotes("SPY")
 
 # calculate ICHIMOKU(9,26,52)
 results = indicators.get_ichimoku(quotes, 9, 26, 52)

diff --git a/docs/_indicators/Kama.md b/docs/_indicators/Kama.md
@@ -62,7 +62,7 @@ See [Utilities and Helpers]({{site.baseurl}}/utilities#utilities-for-indicator-r
 from stock_indicators import indicators
 
 # This method is NOT a part of the library.
-quotes = get_history_from_feed("SPY")
+quotes = get_historical_quotes("SPY")
 
 # Calculate KAMA(10,2,30)
 results = indicators.get_kama(quotes, 10,2,30)

diff --git a/docs/_indicators/Keltner.md b/docs/_indicators/Keltner.md
@@ -62,7 +62,7 @@ See [Utilities and Helpers]({{site.baseurl}}/utilities#utilities-for-indicator-r
 from stock_indicators import indicators
 
 # This method is NOT a part of the library.
-quotes = get_history_from_feed("SPY")
+quotes = get_historical_quotes("SPY")
 
 # Calculate Keltner(20)
 results = indicators.get_keltner(quotes, 20,2.0,10)

diff --git a/docs/_indicators/Kvo.md b/docs/_indicators/Kvo.md
@@ -60,7 +60,7 @@ See [Utilities and Helpers]({{site.baseurl}}/utilities#utilities-for-indicator-r
 from stock_indicators import indicators
 
 # This method is NOT a part of the library.
-quotes = get_history_from_feed("SPY")
+quotes = get_historical_quotes("SPY")
 
 # Calculate Klinger(34,55,13)
 results = indicators.get_kvo(quotes, 34, 55, 13)

diff --git a/docs/_indicators/MaEnvelopes.md b/docs/_indicators/MaEnvelopes.md
@@ -83,7 +83,7 @@ from stock_indicators import indicators
 from stock_indicators import MAType     # Short path, version >= 0.8.1
 
 # This method is NOT a part of the library.
-quotes = get_history_from_feed("SPY")
+quotes = get_historical_quotes("SPY")
 
 # Calculate 20-period SMA envelopes with 2.5% offset
 results = indicators.get_ma_envelopes(quotes, 20, 2.5, MAType.SMA);

diff --git a/docs/_indicators/Macd.md b/docs/_indicators/Macd.md
@@ -66,7 +66,7 @@ See [Utilities and Helpers]({{site.baseurl}}/utilities#utilities-for-indicator-r
 from stock_indicators import indicators
 
 # This method is NOT a part of the library.
-quotes = get_history_from_feed("SPY")
+quotes = get_historical_quotes("SPY")
 
 # calculate MACD(12,26,9)
 results = indicators.get_macd(quotes, 12, 26, 9)

diff --git a/docs/_indicators/Mama.md b/docs/_indicators/Mama.md
@@ -59,7 +59,7 @@ See [Utilities and Helpers]({{site.baseurl}}/utilities#utilities-for-indicator-r
 from stock_indicators import indicators
 
 # This method is NOT a part of the library.
-quotes = get_history_from_feed("SPY")
+quotes = get_historical_quotes("SPY")
 
 # Calculate Mama(0.5,0.05)
 results = indicators.get_mama(quotes, 0.5,0.05)

diff --git a/docs/_indicators/Marubozu.md b/docs/_indicators/Marubozu.md
@@ -52,7 +52,7 @@ See [Utilities and Helpers]({{site.baseurl}}/utilities#utilities-for-indicator-r
 from stock_indicators import indicators
 
 # This method is NOT a part of the library.
-quotes = get_history_from_feed("SPY")
+quotes = get_historical_quotes("SPY")
 
 # Calculate
 results = indicators.get_marubozu(quotes);

diff --git a/docs/_indicators/Mfi.md b/docs/_indicators/Mfi.md
@@ -55,7 +55,7 @@ See [Utilities and Helpers]({{site.baseurl}}/utilities#utilities-for-indicator-r
 from stock_indicators import indicators
 
 # This method is NOT a part of the library.
-quotes = get_history_from_feed("SPY")
+quotes = get_historical_quotes("SPY")
 
 # Calculate
 results = indicators.get_mfi(quotes, 14)

diff --git a/docs/_indicators/Obv.md b/docs/_indicators/Obv.md
@@ -58,7 +58,7 @@ See [Utilities and Helpers]({{site.baseurl}}/utilities#utilities-for-indicator-r
 from stock_indicators import indicators
 
 # This method is NOT a part of the library.
-quotes = get_history_from_feed("SPY")
+quotes = get_historical_quotes("SPY")
 
 # Calculate
 results = indicators.get_obv(quotes)