From: Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Date: Mon, 15 Jan 2018 14:32:11 +0000 (-0800)
Subject: bpo-26330: Update shutil.disk_usage() documentation (GH-5184) (GH-5188)
X-Git-Tag: v3.6.5rc1~157
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=fb8569e36f2629654d5bc9c7ba05978edce408f4;p=python

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 41e5bafa53..3d8cb0301e 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