python / cpython

The Python programming language
https://www.python.org
Other
63.23k stars 30.28k forks source link

Documentation for tarfile has ambigouous references for releases #104638

Closed JMCanning78 closed 2 weeks ago

JMCanning78 commented 1 year ago

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 commented 1 year ago

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

JelleZijlstra commented 1 year ago

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 commented 1 year ago

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 commented 1 year ago

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

hugovk commented 1 year ago

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

hadrizi commented 1 year ago

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

JMCanning78 commented 1 year ago

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

hugovk commented 1 year ago

@hadrizi Sure, go for it.

hadrizi commented 2 weeks ago

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

cc @hugovk @JMCanning78

hugovk commented 2 weeks ago

Thanks, https://github.com/python/cpython/pull/122002 removed this bit of text, so let's close this issue and its PR: https://github.com/python/cpython/pull/109908.