summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRaymond Hettinger <python@rcn.com>2011-01-26 20:40:32 +0000
committerRaymond Hettinger <python@rcn.com>2011-01-26 20:40:32 +0000
commit32074e337e0bf39298b8f7a5fb609dfbcabc8a3b (patch)
treefc241d9006a686fd94df56bab8c763eb3ffb2315
parent57a8689b55ee3a26f53b4b743901b3a55b57b46c (diff)
downloadcpython-git-32074e337e0bf39298b8f7a5fb609dfbcabc8a3b.tar.gz
Add note advising that 'filter' be used as a keyword-argument.
-rw-r--r--Doc/library/tarfile.rst4
1 files changed, 3 insertions, 1 deletions
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)