summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGeorg Brandl <georg@python.org>2009-08-24 17:48:40 +0000
committerGeorg Brandl <georg@python.org>2009-08-24 17:48:40 +0000
commit1b2695a4c24a8f44bc68b3f6bcf9f2d62b67dcef (patch)
treeb1551176a2334783c6837d7825906b065759135b
parent626c0aabe8f6d33b6af9e180277c3c3e95433fdb (diff)
downloadcpython-git-1b2695a4c24a8f44bc68b3f6bcf9f2d62b67dcef.tar.gz
#6677: note that rmdir only removes empty directories.
-rw-r--r--Doc/library/os.rst5
1 files changed, 4 insertions, 1 deletions
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)