From 5ff33837f9b2b3f511bebda3ca88dd4861e0e8db Mon Sep 17 00:00:00 2001 From: Anderson Bravalheri Date: Tue, 15 Oct 2024 17:22:28 +0100 Subject: [PATCH] Add docstring --- setuptools/_shutil.py | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/setuptools/_shutil.py b/setuptools/_shutil.py index ca6397343c..6acbb4281f 100644 --- 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)