From 32074e337e0bf39298b8f7a5fb609dfbcabc8a3b Mon Sep 17 00:00:00 2001 From: Raymond Hettinger Date: Wed, 26 Jan 2011 20:40:32 +0000 Subject: [PATCH] Add note advising that 'filter' be used as a keyword-argument. --- Doc/library/tarfile.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/Doc/library/tarfile.rst b/Doc/library/tarfile.rst index 60b9cd45f3a..a8e1d56ad39 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)