diff options
| author | Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com> | 2018-01-15 14:32:11 (GMT) |
|---|---|---|
| committer | Mariatta <Mariatta@users.noreply.github.com> | 2018-01-15 14:32:11 (GMT) |
| commit | fb8569e36f2629654d5bc9c7ba05978edce408f4 (patch) | |
| tree | 6bf15fb142f07b2622bb67c84394094a916d0123 | |
| parent | bb80645d06c16461b0b58d8983cd7fa6962ba3c6 (diff) | |
| download | cpython-fb8569e36f2629654d5bc9c7ba05978edce408f4.zip cpython-fb8569e36f2629654d5bc9c7ba05978edce408f4.tar.gz cpython-fb8569e36f2629654d5bc9c7ba05978edce408f4.tar.bz2 | |
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)
| -rw-r--r-- | Doc/library/shutil.rst | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/Doc/library/shutil.rst b/Doc/library/shutil.rst index 41e5baf..3d8cb03 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 |