Remove unused comment on BlockCheckedExt trait implementation
What the developer wrote
Authored by Mitchell Bagot
Remove unused comment on BlockCheckedExt trait implementation
Comments applied to function implementations of traits do not render
in compiled Rust documentation. The BlockCheckedExt trait implementation
for Block<Checked> includes such a comment that also duplicates the
warning present on the trait definition.
This patch removes the useless comment above the function total_size
in the BlockCheckedExt implementation of Block<Checked>.
What changed, and why it matters
This commit only removes a documentation comment that duplicated a warning already present on the trait definition. No code behavior changed, and 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 a ‘/// # Panics’ doc comment on the trait implementation of total_size() for Block
Changed components
bitcoin/src/blockdata/block.rsInspect captured patch +0 / −3
diff --git a/bitcoin/src/blockdata/block.rs b/bitcoin/src/blockdata/block.rs
index 9185064f..3211febb 100644
--- a/bitcoin/src/blockdata/block.rs
+++ b/bitcoin/src/blockdata/block.rs
@@ -308,9 +308,6 @@ impl BlockCheckedExt for Block<Checked> {
Weight::from_wu(wu.to_u64())
}
- /// # Panics
- ///
- /// If the size calculation overflows.
fn total_size(&self) -> usize {
let mut size = Header::SIZE;
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.