docs: document the IR::dfs_with_scope method.

VirusTotal · Nov 22, 2024 · 815bdac · 815bdac
1 parent ba09fbd
commit 815bdac
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/lib/src/compiler/ir/mod.rs b/lib/src/compiler/ir/mod.rs
@@ -471,6 +471,10 @@ impl IR {
         DFSIter::new(start, self)
     }
 
+    /// Similar to [`IR::dfs_iter`] but returns an iterator that also can offer
+    /// information about the current scopes.
+    ///
+    /// See [`DFSWithScopeIter`] for details.
     pub fn dfs_with_scope(&self, start: ExprId) -> DFSWithScopeIter {
         DFSWithScopeIter::new(start, self)
     }