Skip to main content

Module conventions

Module conventions 

Source
Expand description

Machine-readable convention notes for indicators whose name does not fully determine their formula (quantwave-xnaf / quantwave-l2n4).

Some indicator slugs are ambiguous in the wild: “ATR” can mean Wilder’s RMA (TA-Lib, TradingView, Wilder 1978) or a plain EMA of true range; “stddev” can be population (ddof=0) or sample (ddof=1); “roc” can be a percentage or a plain ratio. Prose in a docs page is easy to miss, so the convention actually implemented is recorded here as data and surfaced through the Python metadata() / boundary_info() discovery API.

PROCESS RULE (AGENTS.md): the source of every calculation must be recorded and never assumed. source below is the recorded provenance for the convention that is actually implemented. Where no authoritative source has been found for the implemented variant, source says so explicitly rather than naming a plausible-looking one.

Structs§

ConventionNote
One convention that a caller could plausibly get wrong.

Constants§

CONVENTION_NOTES
Slugs whose implemented convention differs from what the bare name implies.

Functions§

convention_notes
Convention notes recorded for slug, if any.
slugs_with_conventions
Every slug that carries at least one convention note, sorted and deduplicated.