Remove unused comments on TransactionExt trait implementation
What the developer wrote
Authored by Mitchell Bagot
Remove unused comments on TransactionExt trait implementation
Comments applied to function implementations of traits do not render
in compiled Rust documentation. The TransactionExt trait implementation
for Transaction includes two such comments that duplicate similar
warnings present in the trait definition.
This patch removes the useless comments above the functions
total_size and base_size in the TransactionExt implementation of
Transaction.
What changed, and why it matters
This commit only removes two short documentation comments from a Rust trait implementation. The actual code behavior is unchanged. There is no security relevance.
No action needed. This is a non-functional documentation cleanup.
Security signals we found
No strong security signals were identified.
Evidence from the diff
The patch deletes two ‘/// # Panics’ doc comments above the base_size and total_size implementations in the TransactionExt impl for Transaction. Trait impl comments do not appear in rustdoc output, so these comments were redundant with the trait definition’s documentation. No executable code was modified.
Changed components
bitcoin/src/blockdata/transaction.rsInspect captured patch +0 / −6
diff --git a/bitcoin/src/blockdata/transaction.rs b/bitcoin/src/blockdata/transaction.rs
index 212cca52..3bfdae53 100644
--- a/bitcoin/src/blockdata/transaction.rs
+++ b/bitcoin/src/blockdata/transaction.rs
@@ -393,9 +393,6 @@ impl TransactionExt for Transaction {
Weight::from_wu(wu.to_u64())
}
- /// # Panics
- ///
- /// If the size calculation overflows.
fn base_size(&self) -> usize {
let mut size: usize = 4; // Serialized length of a u32 for the version number.
@@ -408,9 +405,6 @@ impl TransactionExt for Transaction {
size + absolute::LockTime::SIZE
}
- /// # Panics
- ///
- /// If the size calculation overflows.
#[inline]
fn total_size(&self) -> usize {
let mut size: usize = 4; // Serialized length of a u32 for the version number.
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.