Mirror
/
cpython
mirror of https://github.com/python/cpython
4
1
Fork 0
Code Issues Releases Wiki Activity

Bug #1739115: make shutil.rmtree docs clear wrt. file deletion.

This commit is contained in:
Georg Brandl 2007-06-19 12:38:20 +00:00
parent 75ec1dbd9d
commit 9731eefcfc
1 changed files with 6 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
Doc/lib/libshutil.tex
View File

@ -91,11 +91,12 @@ file type and creator codes will not be correct.
\end{funcdesc} \end{funcdesc}
\begin{funcdesc}{rmtree}{path\optional{, ignore_errors\optional{, onerror}}} \begin{funcdesc}{rmtree}{path\optional{, ignore_errors\optional{, onerror}}}
Delete an entire directory tree.\index{directory!deleting} \index{directory!deleting}
If \var{ignore_errors} is true, Delete an entire directory tree (\var{path} must point to a directory).
errors resulting from failed removals will be ignored; if false or If \var{ignore_errors} is true, errors resulting from failed removals
omitted, such errors are handled by calling a handler specified by will be ignored; if false or omitted, such errors are handled by
\var{onerror} or, if that is omitted, they raise an exception. 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}.