[dn] added some docs

Author: Dan North

zfind

@@ -1,18 +1,37 @@
 #!/usr/bin/env python
 
+''' Recursively search for files contained in jar/zip files.
+
+    This isn't for searching _inside_ the files, like zgrep, but
+    for matching the file names themselves. For instance:
+
+    $ zfind org.apache.http.client.params.HttpClientParams ~/.m2
+
+    will search Maven's local cache for any jars containing the
+    HttpClientParams class. It turns out the dots in the package name
+    conveniently match slashes in the java class's name:
+
+    /home/dnorth/.m2/repository/org/apache/httpcomponents/httpclient/4.0.1/httpclient-4.0.1.jar: org/apache/http/client/params/HttpClientParams.class
+
+    Ah, there it is! '''
+
+__AUTHOR__ = 'Dan North <dan@dannorth.net>'
+
 import os, sys
 from contextlib import closing
 import re
 import zipfile
 
 def scan_file(pattern, path):
+  ''' Search a zip file's contents for matching file names '''
   if zipfile.is_zipfile(path):
     with closing(zipfile.ZipFile(path)) as zf:
       for name in zf.namelist():
         if re.search(pattern, name):
           print "%s: %s" % (path, name)
 
 def scan_zip_files(pattern, path):
+  ''' Use os.walk to recurse down a directory hierarchy looking for zip files '''
   if os.path.isfile(path):
     scan_file(pattern, path)
   else: