[Python-checkins] bpo-26330: Update shutil.disk_usage() documentation (GH-5184) (GH-5188)
Mariatta
webhook-mailer at python.org
Mon Jan 15 09:32:19 EST 2018
https://github.com/python/cpython/commit/fb8569e36f2629654d5bc9c7ba05978edce408f4
commit: fb8569e36f2629654d5bc9c7ba05978edce408f4
branch: 3.6
author: Miss Islington (bot) <31488909+miss-islington at users.noreply.github.com>
committer: Mariatta <Mariatta at users.noreply.github.com>
date: 2018-01-15T06:32:11-08:00
summary:
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)
files:
M Doc/library/shutil.rst
diff --git a/Doc/library/shutil.rst b/Doc/library/shutil.rst
index 41e5bafa53d..3d8cb0301e7 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
More information about the Python-checkins
mailing list