tarfile stream restrictions should be documented
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 77.2k
- Forks
- 35.9k
- PR merge metrics
- PR metrics pending
Description
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.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the tarfile.open documentation and its Examples section, then review the documented TarFile methods for operations that require random access. Document stream-mode restrictions wherever they apply and add an example that demonstrates stream mode, ensuring the resulting documentation clearly identifies unavailable operations.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100