Clarified description of error handling for shutil.rmtree().

freddrake · freddrake · commit 28bdc624a84d · 2002-06-18T14:31:04.000Z
This closes SF patch #569832.
diff --git a/Doc/lib/libshutil.tex b/Doc/lib/libshutil.tex
@@ -78,8 +78,9 @@ \section{\module{shutil} ---
 \begin{funcdesc}{rmtree}{path\optional{, ignore_errors\optional{, onerror}}}
 \index{directory!deleting}
   Delete an entire directory tree.  If \var{ignore_errors} is true,
-  errors will be ignored; if false or omitted, errors are handled by
-  calling a handler specified by \var{onerror} or raise an exception.
+  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}.
