[Python-checkins] cpython (3.4): Issue #23605: os.walk() doc now mentions shutil.rmtree() in the last example

[victor.stinner]

https://hg.python.org/cpython/rev/50e32059a404
changeset:   94924:50e32059a404
branch:      3.4
parent:      94918:54d9c3be8f50
user:        Victor Stinner <victor.stinner at gmail.com>
date:        Tue Mar 10 13:31:47 2015 +0100
summary:
  Issue #23605: os.walk() doc now mentions shutil.rmtree() in the last example

files:
  Doc/library/os.rst |  5 +++--
  1 files changed, 3 insertions(+), 2 deletions(-)


diff --git a/Doc/library/os.rst b/Doc/library/os.rst
--- a/Doc/library/os.rst
+++ b/Doc/library/os.rst
@@ -2391,8 +2391,9 @@
           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.

-- 
Repository URL: https://hg.python.org/cpython