summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
Diffstat (limited to 'Doc')
-rw-r--r--Doc/library/os.rst5
1 files changed, 3 insertions, 2 deletions
diff --git a/Doc/library/os.rst b/Doc/library/os.rst
index 98ee842..41efccd 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.