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.
This commit is contained in:
Cheryl Sabella 2018-01-15 00:08:37 -05:00 committed by Mariatta
parent b3dd18d403
commit ee3b83547c
1 changed files with 2 additions and 1 deletions

View File

@ -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