Skip to content

Commit aff1569

Browse files
committed
gh-141127: Clarify os.symlink() doc without changing argument names
1 parent d7c368c commit aff1569

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

Doc/library/os.rst

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3868,10 +3868,13 @@ features:
38683868

38693869
.. versionadded:: 3.3
38703870

3871+
.. function:: symlink(src, dst, target_is_directory=False, *, dir_fd=None)
38713872

3872-
.. function:: symlink(target, link_name, target_is_directory=False, *, dir_fd=None)
3873+
Create a symbolic link pointing to *src* named *dst*.
38733874

3874-
Create a symbolic link pointing to *target* named *link_name*.
3875+
The *src* parameter refers to the target of the link (the file or directory being linked to),
3876+
and *dst* is the name of the link being created.
3877+
This matches the behavior of the Unix ``ln`` command (``ln TARGET LINK_NAME``).
38753878

38763879
On Windows, a symlink represents either a file or a directory, and does not
38773880
morph to the target dynamically. If the target is present, the type of the

0 commit comments

Comments
 (0)