[Python-checkins] r88202 - python/branches/release27-maint/Doc/library/tarfile.rst

Wed Jan 26 21:40:32 CET 2011

Author: raymond.hettinger
Date: Wed Jan 26 21:40:32 2011
New Revision: 88202
Log:
Add note advising that 'filter' be used as a keyword-argument.
Modified:
 python/branches/release27-maint/Doc/library/tarfile.rst
Modified: python/branches/release27-maint/Doc/library/tarfile.rst
==============================================================================

--- python/branches/release27-maint/Doc/library/tarfile.rst	(original)
+++ python/branches/release27-maint/Doc/library/tarfile.rst	Wed Jan 26 21:40:32 2011
@@ -419,7 +419,9 @@
 
 .. 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)
