aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGustav Sörnäs <gustav@sornas.net>2021-06-15 13:48:24 +0200
committerGustav Sörnäs <gustav@sornas.net>2021-06-15 13:48:24 +0200
commitc774aadf26b7ecc08a548ed5d781ea3fc5eac1b2 (patch)
treebcba66866515b7299876cd406d17963dc1782741
parent14ecdfe2365682e37df99569747b96943ec55426 (diff)
downloadmum-c774aadf26b7ecc08a548ed5d781ea3fc5eac1b2.tar.gz
expand on pre order traversal
-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),