diff options
| author | Federico Ceratto <federico.ceratto@gmail.com> | 2017-02-12 15:02:50 +0000 |
|---|---|---|
| committer | Andreas Rumpf <rumpf_a@web.de> | 2017-02-12 16:02:50 +0100 |
| commit | 0d1aa9225a6190f4d54b699ef3a191cbbb3209a4 (patch) | |
| tree | 927059a2099531a023d648cd588cb781aed8d9c2 /lib | |
| parent | 36d3fd64da21fe128f92ea49943c9dd834aa6848 (diff) | |
| download | Nim-0d1aa9225a6190f4d54b699ef3a191cbbb3209a4.tar.gz | |
Make walkDirRec docstring more clear (#5377)
Diffstat (limited to 'lib')
| -rw-r--r-- | lib/pure/os.nim | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/lib/pure/os.nim b/lib/pure/os.nim index 4cd3870c7..92e295820 100644 --- a/lib/pure/os.nim +++ b/lib/pure/os.nim @@ -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! |