From: Raymond Hettinger <python@rcn.com>
Date: Wed, 26 Jan 2011 20:40:32 +0000 (+0000)
Subject: Add note advising that 'filter' be used as a keyword-argument.
X-Git-Tag: v2.7.2rc1~348
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=32074e337e0bf39298b8f7a5fb609dfbcabc8a3b;p=python

Add note advising that 'filter' be used as a keyword-argument.
---

diff --git a/Doc/library/tarfile.rst b/Doc/library/tarfile.rst
index 60b9cd45f3..a8e1d56ad3 100644
--- a/Doc/library/tarfile.rst
+++ b/Doc/library/tarfile.rst
@@ -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)