Mass patch by Ka-Ping Yee:

    1. Comments at the beginning of the module, before
       functions, and before classes have been turned
       into docstrings.

    2. Tabs are normalized to four spaces.

Also, removed the "remove" function from dircmp.py, which reimplements
list.remove() (it must have been very old).

1 files changed, 27 insertions, 27 deletions

diff --git a/Lib/dircache.py b/Lib/dircache.py
index ef68b429f9..b0a366539c 100644
--- a/Lib/dircache.py
+++ b/Lib/dircache.py
@@ -1,35 +1,35 @@
-# Module 'dircache'
-#
-# Return a sorted list of the files in a directory, using a cache
-# to avoid reading the directory more often than necessary.
-# Also contains a subroutine to append slashes to directories.
+"""Return a sorted list of the files in a directory, using a cache
+to avoid reading the directory more often than necessary.
+Also contains a subroutine to append slashes to directories."""
 
 import os
 
 cache = {}
 
-def listdir(path): # List directory contents, using cache
-	try:
-		cached_mtime, list = cache[path]
-		del cache[path]
-	except KeyError:
-		cached_mtime, list = -1, []
-	try:
-		mtime = os.stat(path)[8]
-	except os.error:
-		return []
-	if mtime <> cached_mtime:
-		try:
-			list = os.listdir(path)
-		except os.error:
-			return []
-		list.sort()
-	cache[path] = mtime, list
-	return list
+def listdir(path):
+    """List directory contents, using cache."""
+    try:
+        cached_mtime, list = cache[path]
+        del cache[path]
+    except KeyError:
+        cached_mtime, list = -1, []
+    try:
+        mtime = os.stat(path)[8]
+    except os.error:
+        return []
+    if mtime <> cached_mtime:
+        try:
+            list = os.listdir(path)
+        except os.error:
+            return []
+        list.sort()
+    cache[path] = mtime, list
+    return list
 
 opendir = listdir # XXX backward compatibility
 
-def annotate(head, list): # Add '/' suffixes to directories
-	for i in range(len(list)):
-		if os.path.isdir(os.path.join(head, list[i])):
-			list[i] = list[i] + '/'
+def annotate(head, list):
+    """Add '/' suffixes to directories."""
+    for i in range(len(list)):
+        if os.path.isdir(os.path.join(head, list[i])):
+            list[i] = list[i] + '/'