bpo-26330: Update shutil.disk_usage() documentation (GH-5184) (GH-5188)

Clarify that on Windows, path must be a directory.
On Unix, path can be a file or a directory.
(cherry picked from commit ee3b83547c6b0cac1da2cb44aaaea533a1d1bbc8)

diff --git a/Doc/library/shutil.rst b/Doc/library/shutil.rst
index 41e5bafa53d46806c3794bac3d18f968a9cf3e76..3d8cb0301e7d982851fe0d94d636e9df2509b9dc 100644 (file)
--- a/Doc/library/shutil.rst
+++ b/Doc/library/shutil.rst
@@ -318,7 +318,8 @@ Directory and files operations
 
    Return disk usage statistics about the given path as a :term:`named tuple`
    with the attributes *total*, *used* and *free*, which are the amount of
-   total, used and free space, in bytes.
+   total, used and free space, in bytes.  On Windows, *path* must be a
+   directory; on Unix, it can be a file or directory.
 
    .. versionadded:: 3.3