[Python-checkins] r74550 - python/trunk/Doc/library/os.rst

[georg.brandl]

Author: georg.brandl
Date: Mon Aug 24 19:48:40 2009
New Revision: 74550

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

Modified:
   python/trunk/Doc/library/os.rst

Modified: python/trunk/Doc/library/os.rst
==============================================================================
--- python/trunk/Doc/library/os.rst	(original)
+++ python/trunk/Doc/library/os.rst	Mon Aug 24 19:48:40 2009
@@ -1121,7 +1121,10 @@
 
 .. 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)