Skip to content

Commit fb837e5

Browse files
committed
Update docstring for walk
Signed-off-by: Jono Yang <jyang@nexb.com>
1 parent dde0cbc commit fb837e5

1 file changed

Lines changed: 3 additions & 0 deletions

File tree

src/commoncode/fileutils.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -375,6 +375,9 @@ def walk(location, ignored=None, allow_symlinks=False):
375375
- optionally ignore files and directories by invoking the `ignored`
376376
callable on files and directories returning True if it should be ignored.
377377
- location is a directory or a file: for a file, the file is returned.
378+
379+
If `allow_symlinks` is True, then symlinks will not be ignored and be
380+
collected like regular files and directories
378381
"""
379382
if on_linux and py2:
380383
location = fsencode(location)

0 commit comments

Comments
 (0)