[Python-checkins] r56041 - python/branches/release25-maint/Doc/lib/libshutil.tex

Tue Jun 19 14:38:27 CEST 2007

Author: georg.brandl
Date: Tue Jun 19 14:38:26 2007
New Revision: 56041
Modified:
 python/branches/release25-maint/Doc/lib/libshutil.tex
Log:
Bug #1739115: make shutil.rmtree docs clear wrt. file deletion.
 (backport from rev. 56040)
Modified: python/branches/release25-maint/Doc/lib/libshutil.tex
==============================================================================

--- python/branches/release25-maint/Doc/lib/libshutil.tex	(original)
+++ python/branches/release25-maint/Doc/lib/libshutil.tex	Tue Jun 19 14:38:26 2007
@@ -91,11 +91,12 @@
 \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}.
