Skip to content

Documentation for tarfile has ambigouous references for releases #104638

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

Closed
JMCanning78 opened this issue May 19, 2023 · 10 comments
Closed

Documentation for tarfile has ambigouous references for releases #104638

JMCanning78 opened this issue May 19, 2023 · 10 comments
Labels
docs Documentation in the Doc dir easy

Comments

@JMCanning78
Copy link

JMCanning78 commented May 19, 2023

Documentation

The documentation for TarFile.extraction_filter under "New in version 3.11.4." it states:
"In Python 3.12+, leaving extraction_filter=None will emit a DeprecationWarning.

In Python 3.14+, leaving extraction_filter=None will cause extraction methods to use the data filter by default."

Perhaps this is a forward looking comment about behavior to expect in Python releases 3.12 and 3.14, but I suspect that they should instead be something like "Python 3.11.2+" and "Python 3.11.4+" to document existing behavior.

Linked PRs

@JMCanning78 JMCanning78 added the docs Documentation in the Doc dir label May 19, 2023
@JMCanning78
Copy link
Author

I don't see a way to add labels to this issue, but it should have 3.11 label attached.

@JelleZijlstra
Copy link
Member

The text as written is correct: this is the anticipated behavior in 3.12 and 3.14. cc @encukou for tarfile filters.

Do you have suggestions for how to make this clearer?

@JMCanning78
Copy link
Author

I guess I don't have a better wording to suggest. When I saw that release 3.13 was skipped, I expected that there was some kind of mistake.

@zware
Copy link
Member

zware commented May 19, 2023

Perhaps instead of Python 3.12+, make it Python 3.12 and 3.13?

@hugovk
Copy link
Member

hugovk commented May 19, 2023

@JMCanning78 Would you like to make a PR with @zware's suggestion?

@hadrizi
Copy link

hadrizi commented Sep 25, 2023

@JMCanning78 are you working on this issue? If not @hugovk can I take it?

@JMCanning78
Copy link
Author

@hadrizi, thanks for asking. No I am not working on this issue.

@hugovk
Copy link
Member

hugovk commented Sep 25, 2023

@hadrizi Sure, go for it.

@hadrizi
Copy link

hadrizi commented Oct 9, 2024

I think this issue is no longer relevant after the changes in #122002

cc @hugovk @JMCanning78

@hugovk
Copy link
Member

hugovk commented Oct 9, 2024

Thanks, #122002 removed this bit of text, so let's close this issue and its PR: #109908.

@hugovk hugovk closed this as not planned Won't fix, can't repro, duplicate, stale Oct 9, 2024
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 easy
Projects
Status: Done
Development

No branches or pull requests

6 participants