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

docs: Add glossary term references to shutil docs (#115559) 

Add glossary term references to shutil docs
This commit is contained in:
Brian Schubert 2024-02-16 17:04:17 -05:00 committed by GitHub
parent 8b776e0f41
commit 318f2190bc
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
Doc/library/shutil.rst
View File

@ -39,7 +39,7 @@ Directory and files operations
.. function:: copyfileobj(fsrc, fdst[, length])
Copy the contents of the file-like object *fsrc* to the file-like object *fdst*.
Copy the contents of the :term:`file-like object <file object>` *fsrc* to the file-like object *fdst*.
The integer *length*, if given, is the buffer size. In particular, a negative
*length* value means to copy the data without looping over the source data in
chunks; by default the data is read in chunks to avoid uncontrolled memory
@ -52,7 +52,7 @@ Directory and files operations
Copy the contents (no metadata) of the file named *src* to a file named
*dst* and return *dst* in the most efficient way possible.
*src* and *dst* are path-like objects or path names given as strings.
*src* and *dst* are :term:`path-like objects <path-like object>` or path names given as strings.
*dst* must be the complete target file name; look at :func:`~shutil.copy`
for a copy that accepts a target directory path. If *src* and *dst*
@ -94,7 +94,7 @@ Directory and files operations
.. function:: copymode(src, dst, *, follow_symlinks=True)
Copy the permission bits from *src* to *dst*. The file contents, owner, and
group are unaffected. *src* and *dst* are path-like objects or path names
group are unaffected. *src* and *dst* are :term:`path-like objects <path-like object>` or path names
given as strings.
If *follow_symlinks* is false, and both *src* and *dst* are symbolic links,
:func:`copymode` will attempt to modify the mode of *dst* itself (rather
@ -113,7 +113,7 @@ Directory and files operations
Copy the permission bits, last access time, last modification time, and
flags from *src* to *dst*. On Linux, :func:`copystat` also copies the
"extended attributes" where possible. The file contents, owner, and
group are unaffected. *src* and *dst* are path-like objects or path
group are unaffected. *src* and *dst* are :term:`path-like objects <path-like object>` or path
names given as strings.
If *follow_symlinks* is false, and *src* and *dst* both