Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 16, 2023

Conversation

miss-islington
Copy link
Contributor

@miss-islington miss-islington commented Jun 14, 2023

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 5cdd5ba)

Co-authored-by: Jelle Zijlstra [email protected]


📚 Documentation preview 📚: https://cpython-previews--105772.org.readthedocs.build/

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 5cdd5ba)

Co-authored-by: Jelle Zijlstra <[email protected]>
@bedevere-bot bedevere-bot added awaiting review docs Documentation in the Doc dir skip news labels Jun 14, 2023
@JelleZijlstra JelleZijlstra merged commit aa927f9 into python:3.11 Jun 16, 2023
@miss-islington miss-islington deleted the backport-5cdd5ba-3.11 branch June 16, 2023 05:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir skip issue skip news
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants