From c774aadf26b7ecc08a548ed5d781ea3fc5eac1b2 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Gustav=20S=C3=B6rn=C3=A4s?= <gustav@sornas.net>
Date: Tue, 15 Jun 2021 13:48:24 +0200
Subject: expand on pre order traversal

---
 mumlib/src/state.rs | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

(limited to 'mumlib/src/state.rs')

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),
-- 
cgit v1.2.1