Skip to content

Commit ee3b835

Browse files
csabellaMariatta
authored andcommitted
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.
1 parent b3dd18d commit ee3b835

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

Doc/library/shutil.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -318,7 +318,8 @@ Directory and files operations
318318

319319
Return disk usage statistics about the given path as a :term:`named tuple`
320320
with the attributes *total*, *used* and *free*, which are the amount of
321-
total, used and free space, in bytes.
321+
total, used and free space, in bytes. On Windows, *path* must be a
322+
directory; on Unix, it can be a file or directory.
322323

323324
.. versionadded:: 3.3
324325

0 commit comments

Comments
 (0)