What the developer wrote
Authored by Tobin C. Harding
Use correct name in rustdocs
Cut'n'pasta error slipped in, notice during review of #4998.
What changed, and why it matters
This commit fixes a typo in a documentation comment. The comment incorrectly referred to a different type (TxMerkleNode) when it should have referred to CompactTarget. There is no code behavior change and no security impact.
No security action needed. This is a documentation-only fix that can be treated as routine maintenance.
Security signals we found
No strong security signals were identified.
Evidence from the diff
A single-line rustdoc comment correction in primitives/src/pow.rs. The macro-generated encoder for CompactTarget had a copy-paste documentation error referencing TxMerkleNode. The diff changes only documentation text; no executable code, types, or logic are modified.
Changed components
primitives/src/pow.rs (documentation only)Inspect captured patch +1 / −1
diff --git a/primitives/src/pow.rs b/primitives/src/pow.rs
index 182791c4..f21f9f97 100644
--- a/primitives/src/pow.rs
+++ b/primitives/src/pow.rs
@@ -49,7 +49,7 @@ impl fmt::UpperHex for CompactTarget {
}
encoding::encoder_newtype! {
- /// The encoder for the [`TxMerkleNode`] type.
+ /// The encoder for the [`CompactTarget`] type.
pub struct CompactTargetEncoder(encoding::ArrayEncoder<4>);
}
Why this scored 15/100
Community notes
Notes can correct, qualify, or add evidence to the AI analysis. Every note shown here has been validated by a human moderator.
The AI analysis stands alone for now. Submit a note if you can add evidence or important context.