Browse code

document fswalk function

git-svn-id: https://s3tools.svn.sourceforge.net/svnroot/s3tools/s3cmd/branches/amax-follow-symlinks@434 830e0280-6d2a-0410-9c65-932aecc39d9d

Aaron Maxwell authored on 2010/07/26 12:40:46
Showing 1 changed files
... ...
@@ -60,6 +60,13 @@ def fswalk_follow_symlinks(path):
60 60
                         yield value
61 61
 
62 62
 def fswalk(path, follow_symlinks):
63
+        '''
64
+        Directory tree generator
65
+
66
+        path (str) is the root of the directory tree to walk
67
+
68
+        follow_symlinks (bool) indicates whether to descend into symbolically linked directories
69
+        '''
63 70
         if follow_symlinks:
64 71
                 return fswalk_follow_symlinks(path)
65 72
         return os.walk(path)