From c9c28bf85ee428e710a510a9825e514d30b0e298 Mon Sep 17 00:00:00 2001 From: sschwarzer Date: Mon, 12 Aug 2019 11:12:22 +0200 Subject: [PATCH] Update documentation on `xmltree.items`/`mitems` (#11930) * Update documentation on `xmltree.items`/`mitems` So far the documentation on `items` and `mitems` wasn't explicit about whether the iteration recurses down the node's children or not. I assumed recursion, which was wrong. * Improve wording in comment Use the more common and shorter word "direct". --- lib/pure/xmltree.nim | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/pure/xmltree.nim b/lib/pure/xmltree.nim index 01e7f8bc6f..5d5eea4d9a 100644 --- a/lib/pure/xmltree.nim +++ b/lib/pure/xmltree.nim @@ -392,7 +392,7 @@ proc clear*(n: var XmlNode) = iterator items*(n: XmlNode): XmlNode {.inline.} = - ## Iterates over any child of `n`. + ## Iterates over all direct children of `n`. ## ## **Examples:** ## @@ -417,7 +417,7 @@ iterator items*(n: XmlNode): XmlNode {.inline.} = for i in 0 .. n.len-1: yield n[i] iterator mitems*(n: var XmlNode): var XmlNode {.inline.} = - ## Iterates over any child of `n` so that it can be modified. + ## Iterates over all direct children of `n` so that they can be modified. assert n.k == xnElement for i in 0 .. n.len-1: yield n[i]