summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorCheryl Sabella <cheryl.sabella@gmail.com>2018-01-15 05:08:37 (GMT)
committerMariatta <Mariatta@users.noreply.github.com>2018-01-15 05:08:37 (GMT)
commitee3b83547c6b0cac1da2cb44aaaea533a1d1bbc8 (patch)
tree393d2529336842e2ea4a067bf9921d43909b7fa8 /Doc
parentb3dd18d4035803b50c65a434955966d1b3b1f363 (diff)
downloadcpython-ee3b83547c6b0cac1da2cb44aaaea533a1d1bbc8.zip
cpython-ee3b83547c6b0cac1da2cb44aaaea533a1d1bbc8.tar.gz
cpython-ee3b83547c6b0cac1da2cb44aaaea533a1d1bbc8.tar.bz2
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.
Diffstat (limited to 'Doc')
-rw-r--r--Doc/library/shutil.rst3
1 files changed, 2 insertions, 1 deletions
diff --git a/Doc/library/shutil.rst b/Doc/library/shutil.rst
index 2b84fa2..1527deb 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