diff options
Diffstat (limited to 'Doc')
| -rw-r--r-- | Doc/lib/libshlex.tex | 3 | ||||
| -rw-r--r-- | Doc/lib/libshutil.tex | 11 | ||||
| -rw-r--r-- | Doc/lib/libtarfile.tex | 10 | ||||
| -rw-r--r-- | Doc/lib/libwinreg.tex | 2 |
4 files changed, 17 insertions, 9 deletions
diff --git a/Doc/lib/libshlex.tex b/Doc/lib/libshlex.tex index 23babd3ccb..230ae9f767 100644 --- a/Doc/lib/libshlex.tex +++ b/Doc/lib/libshlex.tex @@ -28,6 +28,9 @@ in \POSIX{} mode by default, but uses non-\POSIX{} mode if the \var{posix} argument is false. \versionadded{2.3} \versionchanged[Added the \var{posix} parameter]{2.6} +\note{Since the \function{split()} function instantiates a \class{shlex} + instance, passing \code{None} for \var{s} will read the string + to split from standard input.} \end{funcdesc} The \module{shlex} module defines the following class: diff --git a/Doc/lib/libshutil.tex b/Doc/lib/libshutil.tex index 520133287e..65cba54050 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}. diff --git a/Doc/lib/libtarfile.tex b/Doc/lib/libtarfile.tex index 54683a7707..95ea05146d 100644 --- a/Doc/lib/libtarfile.tex +++ b/Doc/lib/libtarfile.tex @@ -314,13 +314,17 @@ tar archive several times. Each archive member is represented by a \end{notice} \end{methoddesc} -\begin{methoddesc}{add}{name\optional{, arcname\optional{, recursive}}} +\begin{methoddesc}{add}{name\optional{, arcname\optional{, recursive\optional{, exclude}}}} Add the file \var{name} to the archive. \var{name} may be any type of file (directory, fifo, symbolic link, etc.). If given, \var{arcname} specifies an alternative name for the file in the archive. Directories are added recursively by default. - This can be avoided by setting \var{recursive} to \constant{False}; - the default is \constant{True}. + This can be avoided by setting \var{recursive} to \constant{False}. + If \var{exclude} is given it must be a function that takes one filename + argument and returns a boolean value. Depending on this value the + respective file is either excluded (\constant{True}) or added + (\constant{False}). + \versionchanged[Added the \var{exclude} parameter]{2.6} \end{methoddesc} \begin{methoddesc}{addfile}{tarinfo\optional{, fileobj}} diff --git a/Doc/lib/libwinreg.tex b/Doc/lib/libwinreg.tex index 1a389648f7..d31c3caefe 100644 --- a/Doc/lib/libwinreg.tex +++ b/Doc/lib/libwinreg.tex @@ -321,7 +321,7 @@ This module offers the following functions: \var{key} is an already open key, or one of the predefined \constant{HKEY_*} constants. - \var{sub_key} is a string that names the subkey with which the + \var{value_name} is a string that names the subkey with which the value is associated. \var{type} is an integer that specifies the type of the data. |