Issue #23605: os.walk() doc now mentions shutil.rmtree() in the last example
authorVictor Stinner <victor.stinner@gmail.com>
Tue, 10 Mar 2015 12:31:47 +0000 (13:31 +0100)
committerVictor Stinner <victor.stinner@gmail.com>
Tue, 10 Mar 2015 12:31:47 +0000 (13:31 +0100)
Doc/library/os.rst

index 98ee842126337e3ea7ea2802c846d5988267c081..41efccd9800b264f6674aed054cbc6557f955cfa 100644 (file)
@@ -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.