aboutsummaryrefslogtreecommitdiffstats
path: root/mumlib/src
diff options
context:
space:
mode:
Diffstat (limited to 'mumlib/src')
-rw-r--r--mumlib/src/state.rs6
1 files changed, 4 insertions, 2 deletions
diff --git a/mumlib/src/state.rs b/mumlib/src/state.rs
index a5262e0..72c01a6 100644
--- a/mumlib/src/state.rs
+++ b/mumlib/src/state.rs
@@ -49,8 +49,10 @@ impl Channel {
}
}
- /// Create an iterator over this channel and its children in a pre-order
- /// traversal.
+ /// Create an iterator over this channel and its children in a [pre-order
+ /// traversal](https://en.wikipedia.org/wiki/Tree_traversal#Pre-order,_NLR)
+ /// which ensures that parent channels are returned before any of its
+ /// children.
pub fn iter(&self) -> Iter<'_> {
Iter {
me: Some(&self),