mirrors/Nim
1
0
Fork 0
mirror of https://github.com/nim-lang/Nim.git synced 2026-01-09 06:23:25 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update documentation on xmltree.items/mitems (#11930)

Browse Source 
* 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".

(cherry picked from commit c9c28bf85e)
This commit is contained in:
sschwarzer
2019-08-12 11:12:22 +02:00
committed by narimiran
parent 2874cfa207
commit 3a064ee3c0
1 changed files with 2 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
lib/pure/xmltree.nim
View File

@@ -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]