mirrors
/
cpython
mirror of https://github.com/python/cpython.git
2
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

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

This closes SF patch #569832.
This commit is contained in:
Fred Drake 2002-06-18 14:31:04 +00:00
parent b1e8154013
commit 28bdc624a8
1 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
Doc/lib/libshutil.tex
View File

@ -78,8 +78,9 @@ file type and creator codes will not be correct.
\begin{funcdesc}{rmtree}{path\optional{, ignore_errors\optional{, onerror}}} \begin{funcdesc}{rmtree}{path\optional{, ignore_errors\optional{, onerror}}}
\index{directory!deleting} \index{directory!deleting}
Delete an entire directory tree. If \var{ignore_errors} is true, Delete an entire directory tree. If \var{ignore_errors} is true,
errors will be ignored; if false or omitted, errors are handled by errors resulting from failed removals will be ignored; if false or
calling a handler specified by \var{onerror} or raise an exception. 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 If \var{onerror} is provided, it must be a callable that accepts
three parameters: \var{function}, \var{path}, and \var{excinfo}. three parameters: \var{function}, \var{path}, and \var{excinfo}.