[Python-checkins] bpo-26468: Doc: improve the documentation of shutil.copy2 when it can fail. (GH-13765)

[Miss Islington (bot)]

https://github.com/python/cpython/commit/c27bcc3b476bbda7958724376189816c4e9d19c4
commit: c27bcc3b476bbda7958724376189816c4e9d19c4
branch: 3.8
author: Miss Islington (bot) <31488909+miss-islington at users.noreply.github.com>
committer: GitHub <noreply at github.com>
date: 2019-09-13T06:43:34-07:00
summary:

bpo-26468: Doc: improve the documentation of shutil.copy2 when it can fail. (GH-13765)

(cherry picked from commit 9585f46b97931d2640c3343dfe03aed15beb9fea)

Co-authored-by: Windson yang <wiwindson at outlook.com>

files:
M Doc/library/shutil.rst

diff --git a/Doc/library/shutil.rst b/Doc/library/shutil.rst
index 88c5f62dd4c9..174b7e875a38 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