os.remove missing exception type
Open
Beginner friendly
Nobody has claimed this yet.
docs
- Dominant language
- Python
- Stars
- 77.2k
- Forks
- 35.9k
- PR merge metrics
- PR metrics pending
Description
Documentation
The documentation for os.remove states On Windows, attempting to remove a file that is in use causes an exception to be raised; but doesnt mention the exception type being returned. The exception type is PermissionError. It should be documented
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 at the documentation entry for os.remove and check the Windows behavior described there. Update the text to name PermissionError as the exception raised when removing an in-use file, then review the rendered wording and documentation checks to confirm the statement is accurate.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 65/100