From: Tim Peters <tim.peters@gmail.com>
Date: Mon, 28 Apr 2003 02:09:43 +0000 (+0000)
Subject: walk() docs:  Worked "walking" into the description and the text.  Added
X-Git-Tag: v2.3c1~953
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=bf89b3a1f7937d7dbbcb2d739b3276c363631d9c;p=thirdparty%2FPython%2Fcpython.git

walk() docs:  Worked "walking" into the description and the text.  Added
a brief example where bottom-up walking is essential.
---

diff --git a/Doc/lib/libos.tex b/Doc/lib/libos.tex
index 760d13ab447a..c92aa4de5c90 100644
--- a/Doc/lib/libos.tex
+++ b/Doc/lib/libos.tex
@@ -1053,7 +1053,8 @@ Availability: Macintosh, \UNIX, Windows.
 \begin{funcdesc}{walk}{top\optional{, topdown\code{=True}}}
 \index{directory!walking}
 \index{directory!traversal}
-\function{walk()} generates the file names in a directory tree.
+\function{walk()} generates the file names in a directory tree, by
+walking the tree either top down or bottom up.
 For each directory in the tree rooted at directory \var{top} (including
 \var{top} itself), it yields a 3-tuple
 \code{(\var{dirpath}, \var{dirnames}, \var{filenames})}.
@@ -1112,6 +1113,22 @@ for root, dirs, files in os.walk('python/Lib/email'):
     if 'CVS' in dirs:
         dirs.remove('CVS')  # don't visit CVS directories
 \end{verbatim}
+
+In the next example, walking the tree bottom up is essential:
+\function{rmdir()} doesn't allow deleting a directory before the
+directory is empty:
+
+\begin{verbatim}
+import os
+from os.path import join
+# Delete everything reachable from the directory named in 'top'.
+for root, dirs, files in os.walk(top, topdown=False):
+    for name in files:
+        os.remove(join(root, name))
+    for name in dirs:
+        os.rmdir(join(root, name))
+\end{verbatim}
+
 \versionadded{2.3}
 \end{funcdesc}