From 2db546ac12b6acb5944afe743106b7288c23a414 Mon Sep 17 00:00:00 2001 From: kingchenc Date: Sat, 23 May 2026 10:38:46 +0200 Subject: [PATCH] chore(coppock): fix unbalanced backticks in the new doc comment MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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. --- crates/wickra-core/src/indicators/coppock.rs | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/crates/wickra-core/src/indicators/coppock.rs b/crates/wickra-core/src/indicators/coppock.rs index e6f2c3d0..aa42624c 100644 --- a/crates/wickra-core/src/indicators/coppock.rs +++ b/crates/wickra-core/src/indicators/coppock.rs @@ -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() {