]> granicus.if.org Git - python/commitdiff
#6677: note that rmdir only removes empty directories.
authorGeorg Brandl <georg@python.org>
Mon, 24 Aug 2009 17:48:40 +0000 (17:48 +0000)
committerGeorg Brandl <georg@python.org>
Mon, 24 Aug 2009 17:48:40 +0000 (17:48 +0000)
Doc/library/os.rst

index cab2522d2afdd65d3c63978979e8ed9703f1368f..4cc6d4f66291635f7d0778bf694eed1eb50aff4a 100644 (file)
@@ -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)