]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
GH-82695: Clarify `pathlib.Path.mkdir()` documentation (#114032)
authorBarney Gale <barney.gale@gmail.com>
Tue, 23 Jan 2024 02:31:09 +0000 (02:31 +0000)
committerGitHub <noreply@github.com>
Tue, 23 Jan 2024 02:31:09 +0000 (02:31 +0000)
Remove a double negative in the documentation of `mkdir()`'s *exist_ok*
parameter.

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

index faff3bc5823cb4e5d5b6cf4946b25ba8b36a7c8b..a6d99d4a64f8016c7deee85d74318504ac4bef62 100644 (file)
@@ -1306,9 +1306,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.