From: Georg Brandl <georg@python.org>
Date: Mon, 24 Aug 2009 17:48:40 +0000 (+0000)
Subject: #6677: note that rmdir only removes empty directories.
X-Git-Tag: v2.7a1~621
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=1b2695a4c24a8f44bc68b3f6bcf9f2d62b67dcef;p=python

#6677: note that rmdir only removes empty directories.
---

diff --git a/Doc/library/os.rst b/Doc/library/os.rst
index cab2522d2a..4cc6d4f662 100644
--- a/Doc/library/os.rst
+++ b/Doc/library/os.rst
@@ -1121,7 +1121,10 @@ Files and Directories
 
 .. function:: rmdir(path)
 
-   Remove the directory *path*. Availability: Unix, Windows.
+   Remove (delete) the directory *path*.  Only works when the directory is
+   empty, otherwise, :exc:`OSError` is raised.  In order to remove whole
+   directory trees, :func:`shutil.rmtree` can be used.  Availability: Unix,
+   Windows.
 
 
 .. function:: stat(path)