Mirror
/
cpython
mirror of https://github.com/python/cpython
4
1
Fork 0
Code Issues Releases Wiki Activity

GH-105900: Fix `pathlib.Path.symlink_to(target_is_directory=...)` docs (#114035) 

Clarify that *target_is_directory* only matters if the target doesn't
exist.
This commit is contained in:
Barney Gale 2024-01-23 05:30:16 +00:00 committed by GitHub
parent 32c227470a
commit b822b85ac1
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 7 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
Doc/library/pathlib.rst
View File

@ -1539,9 +1539,13 @@ call fails (for example because the path doesn't exist).
.. method:: Path.symlink_to(target, target_is_directory=False)
Make this path a symbolic link to *target*. Under Windows,
*target_is_directory* must be true (default ``False``) if the link's target
is a directory. Under POSIX, *target_is_directory*'s value is ignored.
Make this path a symbolic link pointing to *target*.
On Windows, a symlink represents either a file or a directory, and does not
morph to the target dynamically. If the target is present, the type of the
symlink will be created to match. Otherwise, the symlink will be created
as a directory if *target_is_directory* is ``True`` or a file symlink (the
default) otherwise. On non-Windows platforms, *target_is_directory* is ignored.
::