Skip to content

Documentation for tarfile has ambigouous references for releases #104638

Description

@JMCanning78

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

Activity

  1. JMCanning78 commented on May 19, 2023

    @JMCanning78
    Author

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

  2. JelleZijlstra commented on May 19, 2023

    @JelleZijlstra
    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?

  3. JMCanning78 commented on May 19, 2023

    @JMCanning78
    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.

  4. zware commented on May 19, 2023

    @zware
    Member

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

  5. hugovk commented on May 19, 2023

    @hugovk
    Member

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

  6. hadrizi commented on Sep 25, 2023

    @hadrizi

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

  7. JMCanning78 commented on Sep 25, 2023

    @JMCanning78
    Author

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

  8. hugovk commented on Sep 25, 2023

    @hugovk
    Member

    @hadrizi Sure, go for it.

  9. added a commit that references this issue on Sep 26, 2023
  10. hadrizi commented on Oct 9, 2024

    @hadrizi

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

    cc @hugovk @JMCanning78

  11. hugovk commented on Oct 9, 2024

    @hugovk
    Member

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    docsDocumentation in the Doc direasy

    Projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions