Document that shutil.make_archive does not typecheck its logger argument

2012-02-26 01:33:49 +01:00 · 2012-02-26 01:33:49 +01:00 · c446ce78b8
parent 06efea3392
commit c446ce78b8
1 changed files with 2 additions and 1 deletions
--- a/Doc/library/shutil.rst
+++ b/Doc/library/shutil.rst
@ -285,7 +285,8 @@ provided.  They rely on the :mod:`zipfile` and :mod:`tarfile` modules.
   *owner* and *group* are used when creating a tar archive. By default,
   uses the current owner and group.

-   *logger* is an instance of :class:`logging.Logger`.
+   *logger* must be an object compatible with :pep:`282`, usually an instance of
+   :class:`logging.Logger`.

   .. versionadded:: 2.7