Skip to content

Commit

Permalink
docs: rename Actual True Range to Average True Range (#360)
Browse files Browse the repository at this point in the history
As described in #359, I think the indicator name is slightly wrong in
the docs, but correct in the code itself.

This adjusts the docs accordingly.

Closes #359
  • Loading branch information
HerrBertling authored Sep 26, 2023
1 parent 306893d commit 8e6fdc2
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ The following list of indicators are currently supported by this package:
### Volatility Indicators

- [Acceleration Bands](src/indicator/volatility/index.md#acceleration-bands)
- [Actual True Range (ATR)](src/indicator/volatility/index.md#actual-true-range-atr)
- [Average True Range (ATR)](src/indicator/volatility/index.md#average-true-range-atr)
- [Bollinger Band Width](src/indicator/volatility/index.md#bollinger-band-width)
- [Bollinger Bands](src/indicator/volatility/index.md#bollinger-bands)
- [Chandelier Exit](src/indicator/volatility/index.md#chandelier-exit)
Expand Down
4 changes: 2 additions & 2 deletions src/indicator/volatility/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Volatility indicators measure the rate of movement regardless of its direction.

- [Acceleration Bands](#acceleration-bands)
- [Actual True Range (ATR)](#actual-true-range-atr)
- [Average True Range (ATR)](#average-true-range-atr)
- [Bollinger Band Width](#bollinger-band-width)
- [Bollinger Bands](#bollinger-bands)
- [Chandelier Exit](#chandelier-exit)
Expand All @@ -29,7 +29,7 @@ import {accelerationBands} from 'indicatorts';
const result = accelerationBands(highs, lows, closings);
```

#### Actual True Range (ATR)
#### Average True Range (ATR)

The [atr](./atr.ts) function calculates a technical analysis indicator that measures market volatility by decomposing the entire range of stock prices for that period.

Expand Down

0 comments on commit 8e6fdc2

Please sign in to comment.