Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 96acb73

Browse files
committed
Small whitespace fixes for shutil.rmtree() docs.
1 parent 4a7e25f commit 96acb73

1 file changed

Lines changed: 9 additions & 7 deletions

File tree

Doc/library/shutil.rst

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -180,6 +180,7 @@ Directory and files operations
180180
.. versionchanged:: 3.3
181181
Added return of the *dst*.
182182

183+
183184
.. function:: rmtree(path, ignore_errors=False, onerror=None)
184185

185186
.. index:: single: directory; deleting
@@ -193,12 +194,12 @@ Directory and files operations
193194
.. note::
194195

195196
On platforms that support the necessary fd-based functions a symlink
196-
attack resistant version of :func:`rmtree` is used by default. On other
197-
platforms, the :func:`rmtree` implementation is susceptible to a
198-
symlink attack: given proper timing and circumstances, attackers can
199-
manipulate symlinks on the filesystem to delete files they wouldn't
200-
be able to access otherwise. Applications can use the :data:`rmtree.avoids_symlink_attacks` function attribute to
201-
determine which case applies.
197+
attack resistant version of :func:`rmtree` is used by default. On other
198+
platforms, the :func:`rmtree` implementation is susceptible to a symlink
199+
attack: given proper timing and circumstances, attackers can manipulate
200+
symlinks on the filesystem to delete files they wouldn't be able to access
201+
otherwise. Applications can use the :data:`rmtree.avoids_symlink_attacks`
202+
function attribute to determine which case applies.
202203

203204
If *onerror* is provided, it must be a callable that accepts three
204205
parameters: *function*, *path*, and *excinfo*.
@@ -216,11 +217,12 @@ Directory and files operations
216217
.. data:: rmtree.avoids_symlink_attacks
217218

218219
Indicates whether the current platform and implementation provides a
219-
symlink attack resistant version of :func:`rmtree`. Currently this is
220+
symlink attack resistant version of :func:`rmtree`. Currently this is
220221
only true for platforms supporting fd-based directory access functions.
221222

222223
.. versionadded:: 3.3
223224

225+
224226
.. function:: move(src, dst)
225227

226228
Recursively move a file or directory (*src*) to another location (*dst*)

0 commit comments

Comments
 (0)