Skip to content

Commit 6d69b11

Browse files
LeeDongGeon1996LeeDongGeon1996
authored
docs: Update docs for v1.0.0 (#273)
+semver: major
1 parent ae96643 commit 6d69b11

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

47 files changed

+228
-212
lines changed

‎docs/GemFile.lock

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,10 +26,10 @@ GEM
2626
eventmachine (1.2.7)
2727
eventmachine (1.2.7-x64-mingw32)
2828
execjs (2.8.1)
29-
faraday (2.5.2)
29+
faraday (2.6.0)
3030
faraday-net_http (>= 2.0, < 3.1)
3131
ruby2_keywords (>= 0.0.4)
32-
faraday-net_http (3.0.0)
32+
faraday-net_http (3.0.1)
3333
ffi (1.15.5)
3434
ffi (1.15.5-x64-mingw32)
3535
forwardable-extended (2.6.0)
@@ -85,7 +85,7 @@ GEM
8585
octokit (~> 4.0)
8686
public_suffix (>= 3.0, < 5.0)
8787
typhoeus (~> 1.3)
88-
html-pipeline (2.14.2)
88+
html-pipeline (2.14.3)
8989
activesupport (>= 2)
9090
nokogiri (>= 1.4)
9191
html-proofer (3.19.4)
@@ -289,4 +289,4 @@ DEPENDENCIES
289289
wdm (>= 0.1.1)
290290

291291
BUNDLED WITH
292-
2.2.31
292+
2.3.22

‎docs/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ It can be used in any market analysis software using standard OHLCV price quotes
1010

1111
Explore more information:
1212

13-
- [Indicators and overlays]({{site.baseurl}}/indicators/#content)
1413
- [Guide and Pro tips]({{site.baseurl}}/guide/#content)
14+
- [Indicators and overlays]({{site.baseurl}}/indicators/#content)
1515
- [Utilities and Helpers]({{site.baseurl}}/utilities/#content)
1616
- [Demo site](https://stock-charts.azurewebsites.net) (a stock chart)
1717
- [Release notes]({{site.github.repository_url}}/releases)

‎docs/_indicators/Adl.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,8 +39,8 @@ ADLResults[ADLResult]
3939
| name | type | notes
4040
| -- |-- |--
4141
| `date` | datetime | Date
42-
| `money_flow_multiplier` | float | Money Flow Multiplier
43-
| `money_flow_volume` | float | Money Flow Volume
42+
| `money_flow_multiplier` | float, Optional | Money Flow Multiplier
43+
| `money_flow_volume` | float, Optional | Money Flow Volume
4444
| `adl` | float | Accumulation Distribution Line (ADL)
4545
| `adl_sma` | float, Optional | Moving average (SMA) of ADL based on `sma_periods` periods, if specified
4646

‎docs/_indicators/Adx.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,9 +42,10 @@ ADXResults[ADXResult]
4242
| name | type | notes
4343
| -- |-- |--
4444
| `date` | datetime | Date
45-
| `pdi` | float, Optional | Plus Directional Index (+DI) for `N` lookback periods
46-
| `mdi` | float, Optional | Minus Directional Index (-DI) for `N` lookback periods
47-
| `adx` | float, Optional | Average Directional Index (ADX) for `N` lookback periods
45+
| `pdi` | float, Optional | Plus Directional Index (+DI)
46+
| `mdi` | float, Optional | Minus Directional Index (-DI)
47+
| `adx` | float, Optional | Average Directional Index (ADX)
48+
| `adxr` | float, Optional | Average Directional Index Rating (ADXR)
4849

4950
### Utilities
5051

‎docs/_indicators/Alligator.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,9 +47,9 @@ AlligatorResults[AlligatorResult]
4747
| name | type | notes
4848
| -- |-- |--
4949
| `date` | datetime | Date
50-
| `jaw` | Decimal, Optional | Alligator's Jaw
51-
| `teeth` | Decimal, Optional | Alligator's Teeth
52-
| `lips` | Decimal, Optional | Alligator's Lips
50+
| `jaw` | float, Optional | Alligator's Jaw
51+
| `teeth` | float, Optional | Alligator's Teeth
52+
| `lips` | float, Optional | Alligator's Lips
5353

5454
### Utilities
5555

‎docs/_indicators/Alma.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ ALMAResults[ALMAResult]
4242
| name | type | notes
4343
| -- |-- |--
4444
| `date` | datetime | Date
45-
| `alma` | Decimal, Optional | Arnaud Legoux Moving Average
45+
| `alma` | float, Optional | Arnaud Legoux Moving Average
4646

4747
### Utilities
4848

‎docs/_indicators/Aroon.md

Lines changed: 3 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -17,15 +17,6 @@ layout: indicator
1717
| `quotes` | Iterable[Quote] | Iterable(such as list or an object having `__iter__()`) of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes). <br><span class='qna-dataframe'> • [Got in trouble with Pandas.dataframe?]({{site.baseurl}}/guide/#using-pandasdataframe) </span>
1818
| `lookback_periods` | int, *default 25* | Number of periods (`N`) for the lookback evaluation. Must be greater than 0.
1919

20-
<!--
21-
## Usage
22-
```python
23-
from stock_indicators import indicators
24-
25-
results = indicators.get_aroon(quotes, lookback_periods)
26-
``` -->
27-
28-
2920
### Historical quotes requirements
3021

3122
You must have at least `N` periods of `quotes` to cover the warmup periods.
@@ -49,9 +40,9 @@ AroonResults[AroonResult]
4940
| name | type | notes
5041
| -- |-- |--
5142
| `date` | datetime | Date
52-
| `aroon_up` | Decimal, Optional | Based on last High price
53-
| `aroon_down` | Decimal, Optional | Based on last Low price
54-
| `oscillator` | Decimal, Optional | AroonUp - AroonDown
43+
| `aroon_up` | float, Optional | Based on last High price
44+
| `aroon_down` | float, Optional | Based on last Low price
45+
| `oscillator` | float, Optional | AroonUp - AroonDown
5546

5647
### Utilities
5748

‎docs/_indicators/Atr.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,9 +42,9 @@ ATRResults[ATRResult]
4242
| name | type | notes
4343
| -- |-- |--
4444
| `date` | datetime | Date
45-
| `tr` | Decimal, Optional | True Range for current period
46-
| `atr` | Decimal, Optional | Average True Range for `N` lookback periods
47-
| `atrp` | Decimal, Optional | Average True Range Percent is `(atr/Close Price)*100`. This normalizes so it can be compared to other stocks.
45+
| `tr` | float, Optional | True Range for current period
46+
| `atr` | float, Optional | Average True Range
47+
| `atrp` | float, Optional | Average True Range Percent is `(atr/Close Price)*100`. This normalizes so it can be compared to other stocks.
4848

4949
### Utilities
5050

‎docs/_indicators/Beta.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,16 @@ layout: indicator
99
# {{ page.title }}
1010
<hr>
1111

12-
## **get_beta**(*market_history, eval_history, lookback_periods, beta_type=BetaType.STANDARD*)
12+
## **get_beta**(*eval_history, market_quotes, lookback_periods, beta_type=BetaType.STANDARD*)
13+
14+
:warning: <code style='color: #d32f2f; important'>Eval and Market quotes have been reversed in v1! Ensure you swap parameter location. (The warning will be shown and it will be removed after v1.0.0')</code>
1315

1416
## Parameters
1517

1618
| name | type | notes
1719
| -- |-- |--
18-
| `market_history` | Iterable[Quote] | Historical [market] Quotes data should be at any consistent frequency (day, hour, minute, etc). This `market` quotes will be used to establish the baseline. <br><span class='qna-dataframe'> • [Got in trouble with Pandas.dataframe?]({{site.baseurl}}/guide/#using-pandasdataframe) </span>
19-
| `eval_history` | Iterable[Quote] | Historical [evaluation stock] Quotes data should be at any consistent frequency (day, hour, minute, etc).
20+
| `eval_history` | Iterable[Quote] | Historical [evaluation stock] Quotes data should be at any consistent frequency (day, hour, minute, etc). <br><span class='qna-dataframe'> • [Got in trouble with Pandas.dataframe?]({{site.baseurl}}/guide/#using-pandasdataframe) </span>
21+
| `market_history` | Iterable[Quote] | Historical [market] Quotes data should be at any consistent frequency (day, hour, minute, etc). This `market` quotes will be used to establish the baseline.
2022
| `lookback_periods` | int | Number of periods (`N`) in the lookback period. Must be greater than 0 to calculate; however we suggest a larger period for statistically appropriate sample size and especially when using Beta +/-.
2123
| `beta_type` | BetaType, *default BetaType.STANDARD* | Type of Beta to calculate. See [BetaType options](#betatype-options) below.
2224

‎docs/_indicators/BollingerBands.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,9 +41,9 @@ BollingerBandsResults[BollingerBandsResult]
4141
| name | type | notes
4242
| -- |-- |--
4343
| `date` | datetime | Date
44-
| `sma` | Decimal, Optional | Simple moving average (SMA) of Close price (center line)
45-
| `upper_band` | Decimal, Optional | Upper line is `D` standard deviations above the SMA
46-
| `lower_band` | Decimal, Optional | Lower line is `D` standard deviations below the SMA
44+
| `sma` | float, Optional | Simple moving average (SMA) of Close price (center line)
45+
| `upper_band` | float, Optional | Upper line is `D` standard deviations above the SMA
46+
| `lower_band` | float, Optional | Lower line is `D` standard deviations below the SMA
4747
| `percent_b` | float, Optional | `%B` is the location within the bands. `(Price-lower_band)/(upper_band-lower_band)`
4848
| `z_score` | float, Optional | Z-Score of current Close price (number of standard deviations from mean)
4949
| `width` | float, Optional | Width as percent of SMA price. `(upper_band-lower_band)/sma`

‎docs/_indicators/Cci.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ CCIResults[CCIResult]
4040
| name | type | notes
4141
| -- |-- |--
4242
| `date` | datetime | Date
43-
| `cci` | float, Optional | CCI value for `N` lookback periods
43+
| `cci` | float, Optional | Commodity Channel Index
4444

4545
### Utilities
4646

‎docs/_indicators/ChaikinOsc.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -43,9 +43,9 @@ ChaikinOscResults[ChaikinOscResult]
4343
| name | type | notes
4444
| -- |-- |--
4545
| `date` | datetime | Date
46-
| `money_flow_multiplier` | float | Money Flow Multiplier
47-
| `money_flow_volume` | float | Money Flow Volume
48-
| `adl` | float | Accumulation Distribution Line (ADL)
46+
| `money_flow_multiplier` | float, Optional | Money Flow Multiplier
47+
| `money_flow_volume` | float, Optional | Money Flow Volume
48+
| `adl` | float, Optional | Accumulation Distribution Line (ADL)
4949
| `oscillator` | float, Optional | Chaikin Oscillator
5050

5151
:warning: **Warning**: absolute values in MFV, ADL, and Oscillator are somewhat meaningless, so use with caution.

‎docs/_indicators/Chandelier.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ ChandelierResults[ChandelierResult]
5353
| name | type | notes
5454
| -- |-- |--
5555
| `date` | datetime | Date
56-
| `chandelier_exit` | Decimal, Optional | Exit line
56+
| `chandelier_exit` | float, Optional | Exit line
5757

5858
### Utilities
5959

‎docs/_indicators/Cmf.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,9 +40,9 @@ CMFResults[CMFResult]
4040
| name | type | notes
4141
| -- |-- |--
4242
| `date` | datetime | Date
43-
| `money_flow_multiplier` | float | Money Flow Multiplier
44-
| `money_flow_volume` | float | Money Flow Volume
45-
| `cmf` | float, Optional | Chaikin Money Flow = SMA of MFV for `N` lookback periods
43+
| `money_flow_multiplier` | float, Optional | Money Flow Multiplier
44+
| `money_flow_volume` | float, Optional | Money Flow Volume
45+
| `cmf` | float, Optional | Chaikin Money Flow = SMA of MFV
4646

4747
:warning: **Warning**: absolute values in MFV and CMF are somewhat meaningless, so use with caution.
4848

‎docs/_indicators/Dema.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ DEMAResults[DEMAResult]
4242
| name | type | notes
4343
| -- |-- |--
4444
| `date` | datetime | Date
45-
| `dema` | Decimal, Optional | Double exponential moving average
45+
| `dema` | float, Optional | Double exponential moving average
4646

4747
### Utilities
4848

‎docs/_indicators/Dpo.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,8 @@ DPOResults[DPOResult]
4040
| name | type | notes
4141
| -- |-- |--
4242
| `date` | datetime | Date
43-
| `sma` | Decimal, Optional | Simple moving average offset by `N/2+1` periods
44-
| `dpo` | Decimal, Optional | Detrended Price Oscillator (DPO)
43+
| `sma` | float, Optional | Simple moving average offset by `N/2+1` periods
44+
| `dpo` | float, Optional | Detrended Price Oscillator (DPO)
4545

4646
### Utilities
4747

‎docs/_indicators/ElderRay.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -43,9 +43,9 @@ ElderRayResults[ElderRayResult]
4343
| name | type | notes
4444
| -- |-- |--
4545
| `date` | datetime | Date
46-
| `ema` | Decimal, Optional | Exponential moving average of Close price
47-
| `bull_power` | Decimal, Optional | Bull Power
48-
| `bear_power` | Decimal, Optional | Bear Power
46+
| `ema` | float, Optional | Exponential moving average of Close price
47+
| `bull_power` | float, Optional | Bull Power
48+
| `bear_power` | float, Optional | Bear Power
4949

5050
### Utilities
5151

‎docs/_indicators/Ema.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ EMAResults[EMAResult]
4545
| name | type | notes
4646
| -- |-- |--
4747
| `date` | datetime | Date
48-
| `ema` | Decimal, Optional | Exponential moving average
48+
| `ema` | float, Optional | Exponential moving average
4949

5050
### Utilities
5151

‎docs/_indicators/Epma.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ EPMAResults[EPMAResult]
4141
| name | type | notes
4242
| -- |-- |--
4343
| `date` | datetime | Date
44-
| `epma` | Decimal, Optional | Endpoint moving average
44+
| `epma` | float, Optional | Endpoint moving average
4545

4646
### Utilities
4747

‎docs/_indicators/Fractal.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,16 +8,18 @@ layout: indicator
88
# {{ page.title }}
99
<hr>
1010

11-
## **get_fractal**(*quotes, window_span=2*)
11+
## **get_fractal**(*quotes, window_span=2, end_type = EndType.HIGH_LOW*)
12+
13+
### More overloaded interfaces
14+
**get_fractal**(quotes, left_span, right_span, end_type)
1215

1316
## Parameters
1417

1518
| name | type | notes
1619
| -- |-- |--
1720
| `quotes` | Iterable[Quote] | Iterable(such as list or an object having `__iter__()`) of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes). <br><span class='qna-dataframe'> • [Got in trouble with Pandas.dataframe?]({{site.baseurl}}/guide/#using-pandasdataframe) </span>
1821
| `window_span` | int, *default 2* | Evaluation window span width (`S`). Must be at least 2.
19-
20-
<!-- | `endType` | EndType | Determines whether `Close` or `High/Low` are used to find end points. See [EndType options](#endtype-options) below. Default is `EndType.HighLow`. -->
22+
| `end_type` | EndType | Determines whether `close` or `high/low` are used to find end points. See [EndType options](#endtype-options) below. Default is `EndType.HIGH_LOW`.
2123

2224
The total evaluation window size is `2×S+1`, representing `±S` from the evalution date.
2325

@@ -27,12 +29,16 @@ You must have at least `2×S+1` periods of `quotes` to cover the warmup periods;
2729

2830
`quotes` is an `Iterable[Quote]` collection of historical price quotes. It should have a consistent frequency (day, hour, minute, etc). See [the Guide]({{site.baseurl}}/guide/#historical-quotes) for more information.
2931

30-
<!-- ### EndType options
32+
### EndType options
33+
34+
```python
35+
from stock_indicators.indicators.common.enums import EndType
36+
```
3137

3238
| type | description
3339
|-- |--
34-
| `EndType.Close` | Chevron point identified from `Close` price
35-
| `EndType.HighLow` | Chevron point identified from `High` and `Low` price (default) -->
40+
| `CLOSE` | Chevron point identified from `close` price
41+
| `HIGH_LOW` | Chevron point identified from `high` and `low` price (default)
3642

3743
## Returns
3844

‎docs/_indicators/Hma.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ HMAResults[HMAResult]
4040
| name | type | notes
4141
| -- |-- |--
4242
| `date` | datetime | Date
43-
| `hma` | Decimal, Optional | Hull moving average for `N` lookback periods
43+
| `hma` | float, Optional | Hull moving average
4444

4545
### Utilities
4646

‎docs/_indicators/HtTrendline.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,8 @@ HTTrendlineResults[HTTrendlineResult]
4141
| name | type | notes
4242
| -- |-- |--
4343
| `date` | datetime | Date
44-
| `trendline` | Decimal, Optional | HT Trendline
45-
| `smooth_price` | Decimal, Optional | Weighted moving average of `(H+L)/2` price
44+
| `trendline` | float, Optional | HT Trendline
45+
| `smooth_price` | float, Optional | Weighted moving average of `(H+L)/2` price
4646

4747
### Utilities
4848

‎docs/_indicators/Ichimoku.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,12 @@ layout: indicator
1111

1212
## **get_ichimoku**(*quotes, tenkan_periods=9, kijun_periods=26, senkou_b_periods=52*)
1313

14+
### More overloaded interfaces
15+
**get_ichimoku**(quotes, tenkan_periods, kijun_periods, senkou_b_periods,
16+
offset_periods)
17+
**get_ichimoku**(quotes, tenkan_periods, kijun_periods, senkou_b_periods,
18+
senkou_offset, chikou_offset)
19+
1420
## Parameters
1521

1622
| name | type | notes
@@ -19,11 +25,9 @@ layout: indicator
1925
| `tenkan_periods` | int, *default 9* | Number of periods (`T`) in the Tenkan-sen midpoint evaluation. Must be greater than 0.
2026
| `kijun_periods` | int, *default 26* | Number of periods (`K`) in the shorter Kijun-sen midpoint evaluation. Must be greater than 0.
2127
| `senkou_b_periods` | int, *default 52* | Number of periods (`S`) in the longer Senkou leading span B midpoint evaluation. Must be greater than `K`.
22-
23-
<!--
24-
| `offsetPeriods` | int | Optional. Number of periods to offset both `Senkou` and `Chikou` spans. Must be non-negative. Default is `kijunPeriods`.
25-
| `senkouOffset` | int | Optional. Number of periods to offset the `Senkou` span. Must be non-negative. Default is `kijunPeriods`.
26-
| `chikouOffset` | int | Optional. Number of periods to offset the `Chikou` span. Must be non-negative. Default is `kijunPeriods`. -->
28+
| `offset_periods` | int | Number of periods to offset both `Senkou` and `Chikou` spans. Must be non-negative. Default is `kijun_periods`.
29+
| `senkou_offset` | int | Number of periods to offset the `Senkou` span. Must be non-negative. Default is `kijun_periods`.
30+
| `chikou_offset` | int | Number of periods to offset the `Chikou` span. Must be non-negative. Default is `kijun_periods`.
2731

2832
See overloads usage above to determine which parameters are relevant for each. If you are customizing offsets, all parameter arguments must be specified.
2933

‎docs/_indicators/Keltner.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -44,10 +44,10 @@ KeltnerResults[KeltnerResult]
4444
| name | type | notes
4545
| -- |-- |--
4646
| `date` | datetime | Date
47-
| `upper_band` | Decimal, Optional | Upper band of Keltner Channel
48-
| `center_line` | Decimal, Optional | EMA of Close price
49-
| `lower_band` | Decimal, Optional | Lower band of Keltner Channel
50-
| `width` | Decimal, Optional | Width as percent of Centerline price. `(upper_band-lower_band)/center_line`
47+
| `upper_band` | float, Optional | Upper band of Keltner Channel
48+
| `center_line` | float, Optional | EMA of Close price
49+
| `lower_band` | float, Optional | Lower band of Keltner Channel
50+
| `width` | float, Optional | Width as percent of Centerline price. `(upper_band-lower_band)/center_line`
5151

5252
### Utilities
5353

‎docs/_indicators/MaEnvelopes.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -64,9 +64,9 @@ MAEnvelopeResults[MAEnvelopeResult]
6464
| name | type | notes
6565
| -- |-- |--
6666
| `date` | datetime | Date
67-
| `center_line` | Decimal, Optional | Moving average for `N` lookback periods
68-
| `upper_envelope` | Decimal, Optional | Upper envelope band
69-
| `lower_envelope` | Decimal, Optional | Lower envelope band
67+
| `center_line` | float, Optional | Moving average
68+
| `upper_envelope` | float, Optional | Upper envelope band
69+
| `lower_envelope` | float, Optional | Lower envelope band
7070

7171
The moving average `center_line` is based on the `ma_type` type specified.
7272

‎docs/_indicators/Macd.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,8 +50,8 @@ MACDResults[MACDResult]
5050
| `macd` | float, Optional | The MACD line is the difference between slow and fast moving averages (`macd = fast_ema - slow_ema`)
5151
| `signal` | float, Optional | Moving average of the `macd` line
5252
| `histogram` | float, Optional | Gap between of the `macd` and `signal` line
53-
| `fast_ema` | Decimal, Optional | Fast Exponential Moving Average
54-
| `slow_ema` | Decimal, Optional | Slow Exponential Moving Average
53+
| `fast_ema` | float, Optional | Fast Exponential Moving Average
54+
| `slow_ema` | float, Optional | Slow Exponential Moving Average
5555

5656
### Utilities
5757

‎docs/_indicators/Mama.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,8 @@ MAMAResults[MAMAResult]
4343
| name | type | notes
4444
| -- |-- |--
4545
| `date` | datetime | Date
46-
| `mama` | Decimal, Optional | MESA adaptive moving average (MAMA)
47-
| `fama` | Decimal, Optional | Following adaptive moving average (FAMA)
46+
| `mama` | float, Optional | MESA adaptive moving average (MAMA)
47+
| `fama` | float, Optional | Following adaptive moving average (FAMA)
4848

4949
### Utilities
5050

0 commit comments

Comments
 (0)