diff options
| author | Éric Araujo <merwok@netwok.org> | 2011-08-08 14:51:11 (GMT) |
|---|---|---|
| committer | Éric Araujo <merwok@netwok.org> | 2011-08-08 14:51:11 (GMT) |
| commit | e4d5b8e6463126852443123e27af1a2b737f841b (patch) | |
| tree | b7118735c36b963beaa94b285c6f557513212514 /Doc/library/shutil.rst | |
| parent | 7dc76fdeb14e0a2bf1248d78c2439b5a244f8885 (diff) | |
| download | cpython-e4d5b8e6463126852443123e27af1a2b737f841b.zip cpython-e4d5b8e6463126852443123e27af1a2b737f841b.tar.gz cpython-e4d5b8e6463126852443123e27af1a2b737f841b.tar.bz2 | |
Clean up shutil.disk_usage.
- Move a test from call time to define time
- Add the function name to __all__
- Improve docstring and docs
A few lines are now duplicated (named tuple definition and docstring)
but I think the end result reads better.
Diffstat (limited to 'Doc/library/shutil.rst')
| -rw-r--r-- | Doc/library/shutil.rst | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/Doc/library/shutil.rst b/Doc/library/shutil.rst index 6f70206..0d80913 100644 --- a/Doc/library/shutil.rst +++ b/Doc/library/shutil.rst @@ -175,8 +175,9 @@ Directory and files operations .. function:: disk_usage(path) - Return disk usage statistics about the given path as a namedtuple including - total, used and free space expressed in bytes. + 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. .. versionadded:: 3.3 |