Advise to use typing.IO sparingly
Open
Nobody has claimed this yet.
docs
topic-typing
- Dominant language
- Python
- Stars
- 77.2k
- Forks
- 36k
- PR merge metrics
- PR metrics pending
Description
Documentation
typing.IO and subclasses typing.TextIO and typing.BinaryIO are a bit of a legacy feature and should be used sparingly. We should document better alternatives. I'm preparing a PR with some suggestions.
(Cc @gvanrossum @JelleZijlstra @AlexWaygood)
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
The issue concerns documentation for typing.IO, typing.TextIO, and typing.BinaryIO, but names no files, tests, or documentation entry point. Start by locating the relevant typing documentation and reviewing the alternatives being prepared by the reporter. Done means the documentation clearly advises when to use these types sparingly and presents better alternatives.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100