Use correct taproot iter type in rustdoc
What the developer wrote
Authored by Tobin C. Harding
Use correct taproot iter type in rustdoc
This type was apparently changed at some stage and the rustdoc was not
update, new nightly toolchain catches it - WIN.
What changed, and why it matters
This is a one-word documentation fix in a code comment. The developer corrected the name of an iterator type in a rustdoc comment so it matches the actual returned type. No code behavior changed, and there is no security issue.
No security action needed. Treat as a normal documentation fix.
Security signals we found
No strong security signals were identified.
Evidence from the diff
The commit changes a rustdoc comment in bitcoin/src/taproot/mod.rs from TapTreeIter<'_> to ScriptLeaves<'_> to accurately reflect the return type of the script_leaves() method. The implementation and all executable code remain unchanged. This is purely a documentation accuracy fix, likely triggered by a new nightly Rust doc lint.
Changed components
bitcoin/src/taproot/mod.rs documentationInspect captured patch +1 / −1
diff --git a/bitcoin/src/taproot/mod.rs b/bitcoin/src/taproot/mod.rs
index 2eb0c922..ffeadf88 100644
--- a/bitcoin/src/taproot/mod.rs
+++ b/bitcoin/src/taproot/mod.rs
@@ -777,7 +777,7 @@ impl TapTree {
/// Gets the inner [`NodeInfo`] of this tree root.
pub fn into_node_info(self) -> NodeInfo { self.0 }
- /// Returns [`TapTreeIter<'_>`] iterator for a Taproot script tree, operating in DFS order over
+ /// Returns [`ScriptLeaves<'_>`] iterator for a Taproot script tree, operating in DFS order over
/// tree [`ScriptLeaf`]s.
pub fn script_leaves(&self) -> ScriptLeaves<'_> {
ScriptLeaves { leaf_iter: self.0.leaf_nodes() }
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.