jyapayne/Nim
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Make walkDirRec docstring more clear (#5377)

Browse source
This commit is contained in:
Federico Ceratto 2017-02-12 15:02:50 +00:00 • committed by Andreas Rumpf
commit 0d1aa9225a
1 changed files with 2 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

4
lib/pure/os.nim
View file

@ -1002,8 +1002,8 @@ iterator walkDir*(dir: string; relative=false): tuple[kind: PathComponent, path:
iterator walkDirRec*(dir: string, filter={pcFile, pcDir}): string {.
tags: [ReadDirEffect].} =
## walks over the directory `dir` and yields for each file in `dir`. The
## full path for each file is returned.
## Recursively walks over the directory `dir` and yields for each file in `dir`.
## The full path for each file is returned. Directories are not returned.
## **Warning**:
## Modifying the directory structure while the iterator
## is traversing may result in undefined behavior!