From: Georg Brandl <georg@python.org>
Date: Tue, 19 Jun 2007 12:38:26 +0000 (+0000)
Subject: Bug #1739115: make shutil.rmtree docs clear wrt. file deletion.
X-Git-Tag: v2.5.2c1~257
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=5a5adf3a860b449caf3e10d6b3cf1892f2bae146;p=python

Bug #1739115: make shutil.rmtree docs clear wrt. file deletion.
 (backport from rev. 56040)
---

diff --git a/Doc/lib/libshutil.tex b/Doc/lib/libshutil.tex
index f5c55a04b1..13df61aacc 100644
--- a/Doc/lib/libshutil.tex
+++ b/Doc/lib/libshutil.tex
@@ -91,11 +91,12 @@ file type and creator codes will not be correct.
 \end{funcdesc}
 
 \begin{funcdesc}{rmtree}{path\optional{, ignore_errors\optional{, onerror}}}
-  Delete an entire directory tree.\index{directory!deleting}
-  If \var{ignore_errors} is true,
-  errors resulting from failed removals will be ignored; if false or
-  omitted, such errors are handled by calling a handler specified by
-  \var{onerror} or, if that is omitted, they raise an exception.
+  \index{directory!deleting}
+  Delete an entire directory tree (\var{path} must point to a directory).
+  If \var{ignore_errors} is true, errors resulting from failed removals
+  will be ignored; if false or omitted, such errors are handled by
+  calling a handler specified by \var{onerror} or, if that is omitted,
+  they raise an exception.
 
   If \var{onerror} is provided, it must be a callable that accepts
   three parameters: \var{function}, \var{path}, and \var{excinfo}.