summaryrefslogtreecommitdiffstats
path: root/Lib/shutil.py
diff options
context:
space:
mode:
authorRaymond Hettinger <python@rcn.com>2015-08-18 05:04:45 (GMT)
committerRaymond Hettinger <python@rcn.com>2015-08-18 05:04:45 (GMT)
commit5b798abf5b56887d8dcde4e9fa82e405ef4b1dd3 (patch)
tree4bb326ec6a4e0bdac1585d09db97611f905ee29a /Lib/shutil.py
parent02aa3426d393642999bb4f0e1a3125b9391ca399 (diff)
downloadcpython-5b798abf5b56887d8dcde4e9fa82e405ef4b1dd3.zip
cpython-5b798abf5b56887d8dcde4e9fa82e405ef4b1dd3.tar.gz
cpython-5b798abf5b56887d8dcde4e9fa82e405ef4b1dd3.tar.bz2
Issue #24878: Add docstrings to selected namedtuples
Diffstat (limited to 'Lib/shutil.py')
-rw-r--r--Lib/shutil.py3
1 files changed, 3 insertions, 0 deletions
diff --git a/Lib/shutil.py b/Lib/shutil.py
index a5da587..8edabdb 100644
--- a/Lib/shutil.py
+++ b/Lib/shutil.py
@@ -965,6 +965,9 @@ if hasattr(os, 'statvfs'):
__all__.append('disk_usage')
_ntuple_diskusage = collections.namedtuple('usage', 'total used free')
+ _ntuple_diskusage.total.__doc__ = 'Total space in bytes'
+ _ntuple_diskusage.used.__doc__ = 'Used space in bytes'
+ _ntuple_diskusage.free.__doc__ = 'Free space in bytes'
def disk_usage(path):
"""Return disk usage statistics about the given path.