diff options
| author | Larry Hastings <larry@hastings.org> | 2012-07-15 17:57:38 (GMT) |
|---|---|---|
| committer | Larry Hastings <larry@hastings.org> | 2012-07-15 17:57:38 (GMT) |
| commit | b40380667c98a3ab7e244e036944f731d61ffc27 (patch) | |
| tree | bfb57dbbb5fea7e9398adf44366953c86f8462f4 /Doc/library | |
| parent | 509d87d4a06f2812c82df9b2fab83272f6463a81 (diff) | |
| download | cpython-b40380667c98a3ab7e244e036944f731d61ffc27.zip cpython-b40380667c98a3ab7e244e036944f731d61ffc27.tar.gz cpython-b40380667c98a3ab7e244e036944f731d61ffc27.tar.bz2 | |
Issue #15202: Consistently use the name "follow_symlinks" for
new parameters in os and shutil functions. Patch by Serhiy Storchaka.
Diffstat (limited to 'Doc/library')
| -rw-r--r-- | Doc/library/os.rst | 6 | ||||
| -rw-r--r-- | Doc/library/shutil.rst | 2 |
2 files changed, 5 insertions, 3 deletions
diff --git a/Doc/library/os.rst b/Doc/library/os.rst index 6d18300..1b198ce 100644 --- a/Doc/library/os.rst +++ b/Doc/library/os.rst @@ -2211,7 +2211,7 @@ features: os.rmdir(os.path.join(root, name)) -.. function:: fwalk(top='.', topdown=True, onerror=None, followlinks=False, *, dir_fd=None) +.. function:: fwalk(top='.', topdown=True, onerror=None, *, follow_symlinks=False, dir_fd=None) .. index:: single: directory; walking @@ -2224,7 +2224,9 @@ features: and *dirfd* is a file descriptor referring to the directory *dirpath*. This function always supports :ref:`paths relative to directory descriptors - <dir_fd>`. + <dir_fd>` and :ref:`not following symlinks <follow_symlinks>`. Note however + that, unlike other functions, the :funk:`fwalk` default value for + *follow_symlinks* is ``False``. .. note:: diff --git a/Doc/library/shutil.rst b/Doc/library/shutil.rst index e8dde06..f7bfb57 100644 --- a/Doc/library/shutil.rst +++ b/Doc/library/shutil.rst @@ -47,7 +47,7 @@ Directory and files operations be copied. -.. function:: copyfile(src, dst, symlinks=False) +.. function:: copyfile(src, dst, *, follow_symlinks=True) Copy the contents (no metadata) of the file named *src* to a file named *dst* and return *dst*. *dst* must be the complete target file name; look at |