Skip to content

shutil.rmtree - link to example for windows readonly file handling in function docs #134538

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.

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

Open
pmolodo opened this issue May 22, 2025 · 0 comments
Labels
docs Documentation in the Doc dir

Comments

@pmolodo
Copy link

pmolodo commented May 22, 2025

Documentation

The python docs for the shutil module include an example of how to use rmtree on a windows folder that contains read-only files:

https://docs.python.org/3/library/shutil.html#rmtree-example

However, there is no mention of this solution, or even that this is a potential issue on windows, within the documentation for the shutil.rmtree function itself:

https://docs.python.org/3/library/shutil.html#shutil.rmtree

As a result, it is likely that many developers miss this as a potential issue or solution. A simple link to the example, within the shutil.rmtree itself, would increase awareness.

Linked PRs

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir
Projects
Status: Todo
Development

No branches or pull requests

1 participant