summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorWindson yang <wiwindson@outlook.com>2019-09-13 13:36:09 (GMT)
committerStéphane Wirtel <stephane@wirtel.be>2019-09-13 13:36:09 (GMT)
commit9585f46b97931d2640c3343dfe03aed15beb9fea (patch)
tree3804a34c2e06c87ea6b5b44d228e72f14c467300 /Doc
parent995b5d38e7cc24cac3de8dfd516115f86b0bcf80 (diff)
downloadcpython-9585f46b97931d2640c3343dfe03aed15beb9fea.zip
cpython-9585f46b97931d2640c3343dfe03aed15beb9fea.tar.gz
cpython-9585f46b97931d2640c3343dfe03aed15beb9fea.tar.bz2
bpo-26468: Doc: improve the documentation of shutil.copy2 when it can fail. (GH-13765)
Diffstat (limited to 'Doc')
-rw-r--r--Doc/library/shutil.rst3
1 files changed, 2 insertions, 1 deletions
diff --git a/Doc/library/shutil.rst b/Doc/library/shutil.rst
index 88c5f62..174b7e8 100644
--- a/Doc/library/shutil.rst
+++ b/Doc/library/shutil.rst
@@ -187,7 +187,8 @@ Directory and files operations
However, this functionality is not available on all platforms.
On platforms where some or all of this functionality is
unavailable, :func:`copy2` will preserve all the metadata
- it can; :func:`copy2` never returns failure.
+ it can; :func:`copy2` never raises an exception because it
+ cannot preserve file metadata.
:func:`copy2` uses :func:`copystat` to copy the file metadata.
Please see :func:`copystat` for more information