primitives: fix doc comment for OutPointEncoder
What the developer wrote
Authored by sashass1315
primitives: fix doc comment for OutPointEncoder
What changed, and why it matters
This commit fixes a single incorrect word in a documentation comment. The comment previously said the encoder was for one type (TxOut) when it actually encodes a different type (OutPoint). No code behavior changed, and there is no security impact.
No action required; this is a non-security documentation fix.
Security signals we found
No strong security signals were identified.
Evidence from the diff
A one-line documentation correction in primitives/src/transaction.rs changes the doc comment for OutPointEncoder from ‘The encoder for the [TxOut] type.’ to ‘The encoder for the [OutPoint] type.’ The diff contains no executable code changes.
Changed components
primitives/src/transaction.rs documentationInspect captured patch +1 / −1
diff --git a/primitives/src/transaction.rs b/primitives/src/transaction.rs
index 89df54aa..0dcf1d32 100644
--- a/primitives/src/transaction.rs
+++ b/primitives/src/transaction.rs
@@ -1108,7 +1108,7 @@ impl OutPoint {
}
encoding::encoder_newtype! {
- /// The encoder for the [`TxOut`] type.
+ /// The encoder for the [`OutPoint`] type.
pub struct OutPointEncoder<'e>(Encoder2<BytesEncoder<'e>, 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.