From: Victor Stinner <victor.stinner@gmail.com>
Date: Tue, 10 Mar 2015 12:31:47 +0000 (+0100)
Subject: Issue #23605: os.walk() doc now mentions shutil.rmtree() in the last example
X-Git-Tag: v3.5.0a3~213^2
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=47c41b4e4d7d9b6662fb0c3f82e088ea04192dac;p=thirdparty%2FPython%2Fcpython.git

Issue #23605: os.walk() doc now mentions shutil.rmtree() in the last example
---

diff --git a/Doc/library/os.rst b/Doc/library/os.rst
index 98ee84212633..41efccd9800b 100644
--- a/Doc/library/os.rst
+++ b/Doc/library/os.rst
@@ -2391,8 +2391,9 @@ features:
           if 'CVS' in dirs:
               dirs.remove('CVS')  # don't visit CVS directories
 
-   In the next example, walking the tree bottom-up is essential: :func:`rmdir`
-   doesn't allow deleting a directory before the directory is empty::
+   In the next example (simple implementation of :func:`shutil.rmtree`),
+   walking the tree bottom-up is essential, :func:`rmdir` doesn't allow
+   deleting a directory before the directory is empty::
 
       # Delete everything reachable from the directory named in "top",
       # assuming there are no symbolic links.