mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-09-30 12:21:51 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 11

[3.12] docs: Add glossary term references to shutil docs (GH-115559) (#115578)

Browse source 
docs: Add glossary term references to shutil docs (GH-115559)

Add glossary term references to shutil docs
(cherry picked from commit 318f2190bc)

Co-authored-by: Brian Schubert <brianm.schubert@gmail.com>
This commit is contained in:
Miss Islington (bot) 2024-02-16 23:12:49 +01:00 • committed by GitHub
parent 83c7dd5200
commit d08d5b6251
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 4 additions and 4 deletions
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]) .. 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 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 *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 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 Copy the contents (no metadata) of the file named *src* to a file named
*dst* and return *dst* in the most efficient way possible. *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` *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* 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) .. function:: copymode(src, dst, *, follow_symlinks=True)
Copy the permission bits from *src* to *dst*. The file contents, owner, and 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. given as strings.
If *follow_symlinks* is false, and both *src* and *dst* are symbolic links, 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 :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 Copy the permission bits, last access time, last modification time, and
flags from *src* to *dst*. On Linux, :func:`copystat` also copies the flags from *src* to *dst*. On Linux, :func:`copystat` also copies the
"extended attributes" where possible. The file contents, owner, and "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. names given as strings.
If *follow_symlinks* is false, and *src* and *dst* both If *follow_symlinks* is false, and *src* and *dst* both