gavindiaz/wickra
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(wiki): align RollingVwap count with Home and README

Browse Source 
Indicators-Overview.md listed RollingVwap as its own row in the Volume
table (count = 9, total = 72), but Home.md and README.md treat it as
a sub-variant of Vwap (count = 8, total = 71). Drop the standalone row
in Indicators-Overview and fold the rolling variant into the Vwap row.
Warmup-Periods.md keeps both constructors (Vwap::new() and
RollingVwap::new(n) have different warmup periods, which is the whole
purpose of that page) but adds a note explaining that the row count
exceeds the 71 canonical indicators by one.
This commit is contained in:
kingchenc
2026-05-23 19:11:34 +02:00
parent c4ffcc2138
commit a10bda188f
2 changed files with 9 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/wiki/Warmup-Periods.md
+7
View File
@@ -21,6 +21,13 @@ index" in 0-indexed terms is `warmup_period − 1`.
## Single-output indicators
> The rows are keyed by **constructor**, not by indicator name. `Vwap`
> appears twice — once for the cumulative `Vwap::new()` and once for the
> finite-window `RollingVwap::new(period)` — because the two share the
> indicator name `Vwap` (see [Indicators-Overview.md](Indicators-Overview.md))
> but have different warmup periods. That is the only such pair; every other
> row is one canonical indicator.
| Indicator | Constructor | Formula | `warmup_period()` for shown args | Inputs at first emission |
|-----------------|----------------------------------------------|----------------------------------|----------------------------------|--------------------------|
| `Sma` | `Sma::new(14)` | `period` | 14 | 14th |