Add docstring

pypa · Oct 16, 2024 · 5ff3383 · 5ff3383
1 parent 43822f1
commit 5ff3383
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/setuptools/_shutil.py b/setuptools/_shutil.py
@@ -41,6 +41,10 @@ def _auto_chmod(
 
 
 def rmtree(path, ignore_errors=False, onexc=_auto_chmod):
+    """
+    Similar to ``shutil.rmtree`` but automatically executes ``chmod``
+    for well know Windows failure scenarios.
+    """
     return py311.shutil_rmtree(path, ignore_errors, onexc)