summaryrefslogtreecommitdiffstats
path: root/Doc/lib/libshutil.tex
diff options
context:
space:
mode:
Diffstat (limited to 'Doc/lib/libshutil.tex')
-rw-r--r--Doc/lib/libshutil.tex5
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}.