Skip to content

tarfile stream restrictions should be documented #135253

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.

Sign up for GitHub

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

Jump to bottom
Open
randomdude999 opened this issue Jun 8, 2025 · 0 comments
Open

tarfile stream restrictions should be documented #135253

randomdude999 opened this issue Jun 8, 2025 · 0 comments
Labels
docs Documentation in the Doc dir

Comments

@randomdude999
Copy link

Documentation

tarfile documentation mentions stream mode only in tarfile.open, and says "However, such a TarFile object is limited in that it does not allow random access, see Examples."

The examples section does not showcase stream mode at all.

I believe all methods that might be unavailable in stream mode should be documented as such.
@randomdude999 randomdude999 added the docs Documentation in the Doc dir label Jun 8, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docs Documentation in the Doc dir
Projects
Tarfile issues
Status: No status
docs issues
Status: Todo
Milestone
No milestone
Development

No branches or pull requests
1 participant
@randomdude999