Skip to content

Commit 64a41ed

Browse files
committed
Copyedit of os.symlink() docs.
1 parent a102ae3 commit 64a41ed

1 file changed

Lines changed: 13 additions & 15 deletions

File tree

Doc/library/os.rst

Lines changed: 13 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1371,27 +1371,25 @@ Files and Directories
13711371

13721372

13731373
.. function:: symlink(source, link_name)
1374+
symlink(source, link_name, target_is_directory=False)
13741375

13751376
Create a symbolic link pointing to *source* named *link_name*.
13761377

1377-
On Windows, symlink version takes an additional, optional parameter,
1378-
*target_is_directory*, which defaults to False.
1378+
On Windows, symlink version takes an additional optional parameter,
1379+
*target_is_directory*, which defaults to ``False``.
13791380

1380-
symlink(source, link_name, target_is_directory=False)
1381+
On Windows, a symlink represents a file or a directory, and does not morph to
1382+
the target dynamically. For this reason, when creating a symlink on Windows,
1383+
if the target is not already present, the symlink will default to being a
1384+
file symlink. If *target_is_directory* is set to ``True``, the symlink will
1385+
be created as a directory symlink. This parameter is ignored if the target
1386+
exists (and the symlink is created with the same type as the target).
13811387

1382-
On Windows, a symlink represents a file or a directory, and does not
1383-
morph to the target dynamically. For this reason, when creating a
1384-
symlink on Windows, if the target is not already present, the symlink
1385-
will default to being a file symlink. If *target_is_directory* is set to
1386-
True, the symlink will be created as a directory symlink. This
1387-
parameter is ignored if the target exists (and the symlink is created
1388-
with the same type as the target).
1388+
Symbolic link support was introduced in Windows 6.0 (Vista). :func:`symlink`
1389+
will raise a :exc:`NotImplementedError` on Windows versions earlier than 6.0.
1390+
The *SeCreateSymbolicLinkPrivilege* is required in order to create symlinks.
13891391

1390-
Symbolic link support was introduced in Windows 6.0 (Vista). *symlink*
1391-
will raise a NotImplementedError on Windows versions earlier than 6.0. The
1392-
SeCreateSymbolicLinkPrivilege is required in order to create symlinks.
1393-
1394-
Availability: Unix, Windows
1392+
Availability: Unix, Windows.
13951393

13961394
.. versionchanged:: 3.2
13971395
Added support for Windows 6.0 (Vista) symbolic links.

0 commit comments

Comments
 (0)