From: Cheryl Sabella <cheryl.sabella@gmail.com>
Date: Mon, 15 Jan 2018 05:08:37 +0000 (-0500)
Subject: bpo-26330: Update shutil.disk_usage() documentation (GH-5184)
X-Git-Tag: v3.7.0b1~175
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=ee3b83547c6b0cac1da2cb44aaaea533a1d1bbc8;p=thirdparty%2FPython%2Fcpython.git

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

Clarify that on Windows, path must be a directory.
On Unix, path can be a file or a directory.
---

diff --git a/Doc/library/shutil.rst b/Doc/library/shutil.rst
index 2b84fa293728..1527deb167f1 100644
--- 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