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.
This commit is contained in:
Éric Araujo 2011-08-08 16:51:11 +02:00
parent 7dc76fdeb1
commit e4d5b8e646
2 changed files with 33 additions and 16 deletions

View file

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