Skip to content

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

Closed
@pmolodo

Description

@pmolodo

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    docsDocumentation in the Doc dir

    Projects

    Status

    Todo

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions