summaryrefslogtreecommitdiff
path: root/kconfiglib.py
diff options
context:
space:
mode:
authorUlf Magnusson <ulfalizer@gmail.com>2018-09-29 18:22:39 +0200
committerUlf Magnusson <ulfalizer@gmail.com>2018-09-29 18:28:03 +0200
commit53db3ee278f5935751baa46d4999a0b0a469f1de (patch)
tree3df156267c83dc68cd761b57cf74ffcba12d6c60 /kconfiglib.py
parentc1dcaa3ccbb263f021157f2aebd185c6388c28a1 (diff)
Clarify node_iter() documentation re. iteration order
The old version might not have made it obvious that a node is visited before its children.
Diffstat (limited to 'kconfiglib.py')
-rw-r--r--kconfiglib.py5
1 files changed, 3 insertions, 2 deletions
diff --git a/kconfiglib.py b/kconfiglib.py
index 00d00d0..c346c74 100644
--- a/kconfiglib.py
+++ b/kconfiglib.py
@@ -1499,8 +1499,9 @@ class Kconfig(object):
def node_iter(self, unique_syms=False):
"""
Returns a generator for iterating through all MenuNode's in the Kconfig
- tree. The iteration is done in Kconfig definition order (the children
- of a node are visited before the next node is visited).
+ tree. The iteration is done in Kconfig definition order (each node is
+ visited before its children, and the children of a node are visited
+ before the next node).
The Kconfig.top_node menu node is skipped. It contains an implicit menu
that holds the top-level items.