]> granicus.if.org Git - python/commitdiff
Add note advising that 'filter' be used as a keyword-argument.
authorRaymond Hettinger <python@rcn.com>
Wed, 26 Jan 2011 20:40:32 +0000 (20:40 +0000)
committerRaymond Hettinger <python@rcn.com>
Wed, 26 Jan 2011 20:40:32 +0000 (20:40 +0000)
Doc/library/tarfile.rst

index 60b9cd45f3a4ffcd2c22f4c3e443cbf8e0582132..a8e1d56ad395d91f342a915defb59f401d2d6151 100644 (file)
@@ -419,7 +419,9 @@ be finalized; only the internally used file object will be closed. See the
 
    .. deprecated:: 2.7
       The *exclude* parameter is deprecated, please use the *filter* parameter
-      instead.
+      instead.  For maximum portability, *filter* should be used as a keyword
+      argument rather than as a positional argument so that code won't be
+      affected when *exclude* is ultimately removed.
 
 
 .. method:: TarFile.addfile(tarinfo, fileobj=None)