summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorJelle Zijlstra <jelle.zijlstra@gmail.com>2023-06-14 07:26:48 (GMT)
committerGitHub <noreply@github.com>2023-06-14 07:26:48 (GMT)
commit5cdd5ba49db10f05e204e7a49ce184222a93dce8 (patch)
tree3bae884b11b2b01759d69ab0f98c2bbf9b26346b /Doc
parent6199fe3b3236748033a7ce2559aeddb5a91bbbd9 (diff)
downloadcpython-5cdd5ba49db10f05e204e7a49ce184222a93dce8.zip
cpython-5cdd5ba49db10f05e204e7a49ce184222a93dce8.tar.gz
cpython-5cdd5ba49db10f05e204e7a49ce184222a93dce8.tar.bz2
tarfile: Fix positional-only syntax in docs (GH-105770)
The syntax used in the current docs (a / before any args) is invalid. I think the right approach is for the arguments to arbitrary filter functions to be treated as positional-only, meaning that users can supply filter functions with any names for the argument. tarfile.py only calls the filter function with positional arguments.
Diffstat (limited to 'Doc')
-rw-r--r--Doc/library/tarfile.rst8
1 files changed, 4 insertions, 4 deletions
diff --git a/Doc/library/tarfile.rst b/Doc/library/tarfile.rst
index 2f330f0..fd4820e 100644
--- a/Doc/library/tarfile.rst
+++ b/Doc/library/tarfile.rst
@@ -908,7 +908,7 @@ can be:
path to where the archive is extracted (i.e. the same path is used for all
members)::
- filter(/, member: TarInfo, path: str) -> TarInfo | None
+ filter(member: TarInfo, path: str, /) -> TarInfo | None
The callable is called just before each member is extracted, so it can
take the current state of the disk into account.
@@ -928,13 +928,13 @@ Default named filters
The pre-defined, named filters are available as functions, so they can be
reused in custom filters:
-.. function:: fully_trusted_filter(/, member, path)
+.. function:: fully_trusted_filter(member, path)
Return *member* unchanged.
This implements the ``'fully_trusted'`` filter.
-.. function:: tar_filter(/, member, path)
+.. function:: tar_filter(member, path)
Implements the ``'tar'`` filter.
@@ -951,7 +951,7 @@ reused in custom filters:
Return the modified ``TarInfo`` member.
-.. function:: data_filter(/, member, path)
+.. function:: data_filter(member, path)
Implements the ``'data'`` filter.
In addition to what ``tar_filter`` does: