summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>2025-06-18 21:16:07 (GMT)
committerGitHub <noreply@github.com>2025-06-18 21:16:07 (GMT)
commit47ee2aedf11fe6fb274dfc2bfc9ac51136f6113c (patch)
tree0465036c68af9a95872b112ac8cc2c4cc9bfa2fa
parenta93ff87375dc39409a48377f23e9feedeb977e8e (diff)
downloadcpython-47ee2aedf11fe6fb274dfc2bfc9ac51136f6113c.zip
cpython-47ee2aedf11fe6fb274dfc2bfc9ac51136f6113c.tar.gz
cpython-47ee2aedf11fe6fb274dfc2bfc9ac51136f6113c.tar.bz2
gh-134538: Add link to shutil.rmtree example in function docs (GH-135540)
(cherry picked from commit e9b647dd30d22cef465972d898a34c4b1bb6615d) Co-authored-by: alexey semenyuk <alexsemenyuk88@gmail.com>
-rw-r--r--Doc/library/shutil.rst4
1 files changed, 4 insertions, 0 deletions
diff --git a/Doc/library/shutil.rst b/Doc/library/shutil.rst
index c78dfe1..e7c4c4f 100644
--- a/Doc/library/shutil.rst
+++ b/Doc/library/shutil.rst
@@ -327,6 +327,10 @@ Directory and files operations
The deprecated *onerror* is similar to *onexc*, except that the third
parameter it receives is the tuple returned from :func:`sys.exc_info`.
+ .. seealso::
+ :ref:`shutil-rmtree-example` for an example of handling the removal
+ of a directory tree that contains read-only files.
+
.. audit-event:: shutil.rmtree path,dir_fd shutil.rmtree
.. versionchanged:: 3.3