diff options
| author | Fred Drake <fdrake@acm.org> | 2002-06-18 14:31:04 (GMT) |
|---|---|---|
| committer | Fred Drake <fdrake@acm.org> | 2002-06-18 14:31:04 (GMT) |
| commit | 28bdc624a84d9da7b486a992db967db78023cf8c (patch) | |
| tree | 5989d5ab1bb54b1b2c94ba05ab4667e528b05ab6 /Doc/lib/libshutil.tex | |
| parent | b1e8154013feaa42d08e3a9b992357c365129126 (diff) | |
| download | cpython-28bdc624a84d9da7b486a992db967db78023cf8c.zip cpython-28bdc624a84d9da7b486a992db967db78023cf8c.tar.gz cpython-28bdc624a84d9da7b486a992db967db78023cf8c.tar.bz2 | |
Clarified description of error handling for shutil.rmtree().
This closes SF patch #569832.
Diffstat (limited to 'Doc/lib/libshutil.tex')
| -rw-r--r-- | Doc/lib/libshutil.tex | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/Doc/lib/libshutil.tex b/Doc/lib/libshutil.tex index deb2ed2..b675f25 100644 --- a/Doc/lib/libshutil.tex +++ b/Doc/lib/libshutil.tex @@ -78,8 +78,9 @@ file type and creator codes will not be correct. \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}. |