From fd8949b8b78b065972893252084fa5297dc8b92f Mon Sep 17 00:00:00 2001
From: Bastian Kleineidam <bastian.kleineidam@web.de>
Date: Wed, 9 Jan 2013 22:26:00 +0100
Subject: [PATCH] Add missing docstrings.

---
 Makefile               | 1 +
 scripts/gocomics.py    | 1 +
 scripts/keenspot.py    | 1 +
 scripts/mktestpage.py  | 6 ++++++
 scripts/removeafter.py | 1 +
 scripts/smackjeeves.py | 1 +
 scripts/universal.py   | 1 +
 7 files changed, 12 insertions(+)

diff --git a/Makefile b/Makefile
index b0925f7b5..e94166286 100644
--- a/Makefile
+++ b/Makefile
@@ -103,6 +103,7 @@ doccheck:
 	py-check-docstrings --force \
 	  dosagelib/*.py \
 	  dosage \
+	  scripts \
 	  *.py
 
 pyflakes:
diff --git a/scripts/gocomics.py b/scripts/gocomics.py
index 09a225fd3..59ec04401 100755
--- a/scripts/gocomics.py
+++ b/scripts/gocomics.py
@@ -74,6 +74,7 @@ def get_results():
 
 
 def has_creators_comic(name):
+    """Test if comic name already exists."""
     cname = "Creators/%s" % name
     for scraperclass in get_scrapers():
         lname = scraperclass.get_name().lower()
diff --git a/scripts/keenspot.py b/scripts/keenspot.py
index 9590d93e9..272b64af4 100755
--- a/scripts/keenspot.py
+++ b/scripts/keenspot.py
@@ -401,6 +401,7 @@ def get_results():
 
 
 def has_comic(name):
+    """Check if comic name already exists."""
     cname = ("Creators/%s" % name).lower()
     gname = ("GoComics/%s" % name).lower()
     for scraperclass in get_scrapers():
diff --git a/scripts/mktestpage.py b/scripts/mktestpage.py
index a9a7b5b7e..949fa3f81 100755
--- a/scripts/mktestpage.py
+++ b/scripts/mktestpage.py
@@ -45,10 +45,12 @@ def get_mtime (filename):
 
 
 def strdate(t):
+    """Get formatted date string."""
     return time.strftime("%d.%m.%Y", time.localtime(t))
 
 
 def get_test_name(line):
+    """Get scraper name from test output line."""
     classname = line.split('::')[1][4:]
     for scraper in get_scrapers():
         if scraper.__name__ == classname:
@@ -61,12 +63,14 @@ def get_test_name(line):
 
 
 def get_test(line):
+    """Get test name from test output line."""
     name, url = get_test_name(line)
     result = "OK" if line.startswith(". ") else "FAILED"
     return [name, url, result, ""]
 
 
 def get_content(filename):
+    """Get HTML content for test output."""
     tests = []
     with open(filename, "r") as f:
         print("Tests parsed: 0", end=" ", file=sys.stderr)
@@ -103,10 +107,12 @@ def get_content(filename):
 
 
 def quote_all(*args):
+    """CGI-escape all arguments for."""
     return tuple(cgi.escape(x, quote=True) for x in args)
 
 
 def main(args):
+    """Generate HTML output for test result."""
     filename = args[0]
     modified = get_mtime(filename)
     content = get_content(filename)
diff --git a/scripts/removeafter.py b/scripts/removeafter.py
index 9fd5ddf87..d75560ff1 100755
--- a/scripts/removeafter.py
+++ b/scripts/removeafter.py
@@ -7,6 +7,7 @@ import fileinput
 import sys
 
 def main(args):
+    """Remove lines after marker."""
     filename = args[0]
     marker = args[1]
     for line in fileinput.input(filename, inplace=1):
diff --git a/scripts/smackjeeves.py b/scripts/smackjeeves.py
index fac28e676..2604fe30d 100755
--- a/scripts/smackjeeves.py
+++ b/scripts/smackjeeves.py
@@ -284,6 +284,7 @@ def get_results():
 
 
 def has_comic(name):
+    """Check if comic name already exists."""
     cname = name.lower()
     for scraperclass in get_scrapers():
         lname = scraperclass.get_name().lower()
diff --git a/scripts/universal.py b/scripts/universal.py
index 6d0f2819d..4585fa78b 100755
--- a/scripts/universal.py
+++ b/scripts/universal.py
@@ -68,6 +68,7 @@ def get_results():
 
 
 def has_comic(name):
+    """Check if comic name already exists."""
     cname = ("Creators/%s" % name).lower()
     gname = ("GoComics/%s" % name).lower()
     for scraperclass in get_scrapers():