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

2019-09-13 21:36:09 +08:00 · 2019-09-13 21:36:09 +08:00 · 9585f46b97
parent 995b5d38e7
commit 9585f46b97
1 changed files with 2 additions and 1 deletions
--- 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