Skip to content

Commit

Permalink
fix Renko docs
Browse files Browse the repository at this point in the history
  • Loading branch information
DaveSkender committed Nov 3, 2024
1 parent 8c2748a commit 97f162a
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion docs/_indicators/Renko.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,9 +107,10 @@ RenkoResults[RenkoResult]

- This method returns a time series of all available indicator values for the `quotes` provided.
- `RenkoResults` is just a list of `RenkoResult`.
- It always returns the same number of elements as there are in the historical quotes.
- It does not return a single incremental indicator value.

>🚩 **Warning**: Unlike most indicators in this library, this indicator DOES NOT return the same number of elements as there are in the historical quotes. Renko bricks are added to the results once the `brickSize` change is achieved. For example, if it takes 3 days for a $2.50 price change to occur an entry is made on the third day while the first two are skipped. If a period change occurs at multiples of `brickSize`, multiple bricks are drawn with the same `Date`. See [online documentation](https://www.investopedia.com/terms/r/renkochart.asp) for more information.
>👉 **Repaint warning**: When using the `GetRenkoAtr()` variant, the last [Average True Range (ATR)]({{site.baseurl}}/indicators/Atr/#content) value is used to set `brickSize`. Since the ATR changes over time, historical bricks will be repainted as new periods are added or updated in `quotes`.
## Example for ATR variant
Expand Down

0 comments on commit 97f162a

Please sign in to comment.