Documenting the RsiPeriod function. (#74)

cinar · May 21, 2022 · 098a42b · 098a42b
1 parent 7e5365e
commit 098a42b
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 1 deletion.
diff --git a/momentum_indicators.go b/momentum_indicators.go
@@ -81,7 +81,6 @@ func Rsi(closing []float64) ([]float64, []float64) {
 }
 
 // RsiPeriod allows to calculate the RSI indicator with a non-standard period.
-
 func RsiPeriod(period int, closing []float64) ([]float64, []float64) {
 	gains := make([]float64, len(closing))
 	losses := make([]float64, len(closing))

diff --git a/momentum_indicators.md b/momentum_indicators.md
@@ -64,6 +64,11 @@ RSI = 100 - (100 / (1 + RS))
 ```Golang
 rs, rsi := indicator.Rsi(closing)
 ```
+The [RsiPeriod](https://pkg.go.dev/github.com/cinar/indicator#RsiPeriod) allows to calculate the RSI indicator with a non-standard period.
+
+```Golang
+rs, rsi := indicator.RsiPeriod(period, closing)
+```
 
 #### Stochastic Oscillator