Merge #522: Update TapTree::iter docs

apoelstra · apoelstra · commit bc687d2e9eb4 · 2023-01-18T17:47:45.000Z
3fcc84c Update TapTree::iter docs (sanket1729) Pull request description: Fixes #441 ACKs for top commit: apoelstra: ACK 3fcc84c Tree-SHA512: 31f6fea5f6d33bee5bd86fc2d78bbca71c5fef5ff6a027cc6360c4e8489f7963ee7f826863d612d75d9ab49e2f5f5acbd48099cd231bc137c5e6d36d1df01f59
diff --git a/src/descriptor/tr.rs b/src/descriptor/tr.rs
@@ -120,7 +120,8 @@ impl<Pk: MiniscriptKey> TapTree<Pk> {
         }
     }
 
-    /// Iterate over all miniscripts
+    /// Iterates over all miniscripts in DFS walk order compatible with the
+    /// PSBT requirements (BIP 371).
     pub fn iter(&self) -> TapTreeIter<Pk> {
         TapTreeIter {
             stack: vec![(0, self)],

Original file line number	Diff line number	Diff line change
`@@ -120,7 +120,8 @@ impl<Pk: MiniscriptKey> TapTree<Pk> {`
`120`	`120`	`}`
`121`	`121`	`}`
`122`	`122`
`123`		`- /// Iterate over all miniscripts`
	`123`	`+ /// Iterates over all miniscripts in DFS walk order compatible with the`
	`124`	`+ /// PSBT requirements (BIP 371).`
`124`	`125`	`pub fn iter(&self) -> TapTreeIter<Pk> {`
`125`	`126`	`TapTreeIter {`
`126`	`127`	`stack: vec![(0, self)],`