Discussion of sys module in Data Model
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 77.2k
- Forks
- 35.9k
- PR merge metrics
- PR metrics pending
Description
Documentation
In the section titled "I/O objects (also known as file objects)" in the Data Model chapter, it says:
The objects sys.stdin, sys.stdout and sys.stderr are initialized to file objects corresponding to the interpreter’s standard input, output and error streams; they are all open in text mode and therefore follow the interface defined by the io.TextIOBase abstract class.
However, neither the sys nor the io modules have been introduced (and probably should not be in this chapter). Is it appropriate to talk about module-specific features here? Or maybe this text should be modified to lean towards those objects just as examples of file objects?
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 “I/O objects (also known as file objects)” section in the Data Model chapter and read the surrounding discussion to assess whether the sys and io references are introduced appropriately. Done means resolving whether to retain these module-specific examples or revise the passage to present them only as examples of file objects.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100