From: Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Date: Fri, 16 Jun 2023 05:43:30 +0000 (-0700)
Subject: [3.11] tarfile: Fix positional-only syntax in docs (GH-105770) (#105772)
X-Git-Tag: v3.11.5~271
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=aa927f9f9684454b3022f65baca12b6e2a8c0721;p=thirdparty%2FPython%2Fcpython.git

[3.11] tarfile: Fix positional-only syntax in docs (GH-105770) (#105772)

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.
(cherry picked from commit 5cdd5ba49db10f05e204e7a49ce184222a93dce8)

Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
---

diff --git a/Doc/library/tarfile.rst b/Doc/library/tarfile.rst
index 345bde349f55..41428740ba3b 100644
--- a/Doc/library/tarfile.rst
+++ b/Doc/library/tarfile.rst
@@ -901,7 +901,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.
@@ -921,13 +921,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.
 
@@ -944,7 +944,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: