]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
[3.11] GH-82695: Clarify `pathlib.Path.mkdir()` documentation (GH-114032) (#114463)
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Tue, 23 Jan 2024 02:37:55 +0000 (03:37 +0100)
committerGitHub <noreply@github.com>
Tue, 23 Jan 2024 02:37:55 +0000 (02:37 +0000)
Remove a double negative in the documentation of `mkdir()`'s *exist_ok*
parameter.

(cherry picked from commit 32c227470aa6f72950b76206ffc529c258b4b8fa)

Co-authored-by: Barney Gale <barney.gale@gmail.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Doc/library/pathlib.rst

index 283e324a7f1b05f9fcffa47be3e4f82c31487171..528236cfa7eaa6d18add1b7de5daccf18e6a3239 100644 (file)
@@ -994,9 +994,9 @@ call fails (for example because the path doesn't exist).
    If *exist_ok* is false (the default), :exc:`FileExistsError` is
    raised if the target directory already exists.
 
-   If *exist_ok* is true, :exc:`FileExistsError` exceptions will be
-   ignored (same behavior as the POSIX ``mkdir -p`` command), but only if the
-   last path component is not an existing non-directory file.
+   If *exist_ok* is true, :exc:`FileExistsError` will not be raised unless the given
+   path already exists in the file system and is not a directory (same
+   behavior as the POSIX ``mkdir -p`` command).
 
    .. versionchanged:: 3.5
       The *exist_ok* parameter was added.