Skip to content

Commit bb93502

Browse files
committed
Add docstring
1 parent 8272bc3 commit bb93502

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

setuptools/_shutil.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,10 @@ def _auto_chmod(
4141

4242

4343
def rmtree(path, ignore_errors=False, onexc=_auto_chmod):
44+
"""
45+
Similar to ``shutil.rmtree`` but automatically executes ``chmod``
46+
for well know Windows failure scenarios.
47+
"""
4448
return py311.shutil_rmtree(path, ignore_errors, onexc)
4549

4650

0 commit comments

Comments
 (0)