]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
gh-134538: Add link to shutil.rmtree example in function docs (GH-135540)
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Wed, 18 Jun 2025 21:16:07 +0000 (23:16 +0200)
committerGitHub <noreply@github.com>
Wed, 18 Jun 2025 21:16:07 +0000 (21:16 +0000)
(cherry picked from commit e9b647dd30d22cef465972d898a34c4b1bb6615d)

Co-authored-by: alexey semenyuk <alexsemenyuk88@gmail.com>
Doc/library/shutil.rst

index c78dfe1aafa0ed0b29f59f23910a5d4d113acdde..e7c4c4f46bd0117c6a157ffce33ae11eff34cd6b 100644 (file)
@@ -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