MetzNet
/
dfhack
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Move docs for include_prefix param to correct function 

It was listed under listdir, but it only appears in listdir_recursive
develop
Myk 2022-04-08 23:06:54 -07:00
parent 39f5084902
commit c603d6a9f3
1 changed files with 2 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/Lua API.rst
Unescape Escape View File

@ -2266,8 +2266,6 @@ unless otherwise noted.
* ``dfhack.filesystem.listdir(path)`` * ``dfhack.filesystem.listdir(path)``
Lists files/directories in a directory. Returns ``{}`` if ``path`` does not exist. Lists files/directories in a directory. Returns ``{}`` if ``path`` does not exist.
Set include_prefix to false if you don't want the ``path`` string prepended to the
returned filenames.
* ``dfhack.filesystem.listdir_recursive(path [, depth = 10[, include_prefix = true]])`` * ``dfhack.filesystem.listdir_recursive(path [, depth = 10[, include_prefix = true]])``
@ -2278,7 +2276,8 @@ unless otherwise noted.
Note that ``listdir()`` returns only the base name of each directory entry, while Note that ``listdir()`` returns only the base name of each directory entry, while
``listdir_recursive()`` returns the initial path and all components following it ``listdir_recursive()`` returns the initial path and all components following it
for each entry. for each entry. Set ``include_prefix`` to false if you don't want the ``path``
string prepended to the returned filenames.
Console API Console API
----------- -----------