diff options
| author | Georg Brandl <georg@python.org> | 2007-06-19 12:38:20 (GMT) |
|---|---|---|
| committer | Georg Brandl <georg@python.org> | 2007-06-19 12:38:20 (GMT) |
| commit | 9731eefcfc61379a287246006fe80d7a7d7532ad (patch) | |
| tree | 1070b6358d065944b25b4ef6025bd8a009838e9d | |
| parent | 75ec1dbd9d06de1239ee04c020c8db8af6cd18d6 (diff) | |
| download | cpython-9731eefcfc61379a287246006fe80d7a7d7532ad.zip cpython-9731eefcfc61379a287246006fe80d7a7d7532ad.tar.gz cpython-9731eefcfc61379a287246006fe80d7a7d7532ad.tar.bz2 | |
Bug #1739115: make shutil.rmtree docs clear wrt. file deletion.
| -rw-r--r-- | Doc/lib/libshutil.tex | 11 |
1 files changed, 6 insertions, 5 deletions
diff --git a/Doc/lib/libshutil.tex b/Doc/lib/libshutil.tex index 2359dea..c5a28a0 100644 --- a/Doc/lib/libshutil.tex +++ b/Doc/lib/libshutil.tex @@ -91,11 +91,12 @@ file type and creator codes will not be correct. \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}. |