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

chore(coppock): fix unbalanced backticks in the new doc comment

Browse Source 
Follow-up to b340ecd — the doc comment on
`warmup_period_matches_first_some_for_every_parameter_set` had an
unbalanced inline-code span ("`Some``") that tripped
`clippy::doc_invalid_doc_attributes` (caught by `clippy -D warnings`
but not by `cargo build` or `cargo test`). Rephrased the sentence so
every backtick is paired. No code change, no test change.
This commit is contained in:
kingchenc
2026-05-23 10:38:46 +02:00
parent b340ecd3d6
commit 2db546ac12
1 changed files with 6 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
crates/wickra-core/src/indicators/coppock.rs
+6 -6
View File
@@ -154,12 +154,12 @@ mod tests {
assert!(out[8].is_some());
}
/// `warmup_period() == 1-based index of the first `Some`` for every legal
/// parameter combination — including the parameter set
/// `(roc_long=4, roc_short=2, wma=3)` that an external audit claimed
/// would prove the formula off by one. It does not: the slower ROC first
/// emits at 0-based index 4, the WMA needs 3 such inputs and emits at
/// 0-based index 6 (the 7th input), which is what
/// `warmup_period()` equals the 1-based index of the first emitted
/// `Some` for every legal parameter combination — including the
/// parameter set `(roc_long=4, roc_short=2, wma=3)` that an external
/// audit claimed would prove the formula off by one. It does not: the
/// slower ROC first emits at 0-based index 4, the WMA needs 3 such inputs
/// and emits at 0-based index 6 (the 7th input), which is what
/// `roc_long.max(roc_short) + wma = max(4, 2) + 3 = 7` reports.
#[test]
fn warmup_period_matches_first_some_for_every_parameter_set() {