From cded5172465b7bcd8bb2d013a856a898303c4b6b Mon Sep 17 00:00:00 2001
From: Helmut Grohne <helmut@subdivi.de>
Date: Sat, 12 Jul 2008 15:01:37 +0200
Subject: fix some comments and epydocify them

---
 wsgitools/digest.py      | 4 +++-
 wsgitools/filters.py     | 4 ++--
 wsgitools/middlewares.py | 2 +-
 3 files changed, 6 insertions(+), 4 deletions(-)

(limited to 'wsgitools')

diff --git a/wsgitools/digest.py b/wsgitools/digest.py
index 28fb9c7..c30d0e9 100755
--- a/wsgitools/digest.py
+++ b/wsgitools/digest.py
@@ -13,7 +13,9 @@ import time
 sysrand = random.SystemRandom()
 
 def parse_digest_response(data, ret=dict()):
-    """internal"""
+    """internal
+    @raises ValueError:
+    """
     data = data.strip()
     key, rest = data.split('=', 1) # raises ValueError
     if rest.startswith('"'):
diff --git a/wsgitools/filters.py b/wsgitools/filters.py
index d98773f..1c7d03b 100644
--- a/wsgitools/filters.py
+++ b/wsgitools/filters.py
@@ -61,7 +61,7 @@ class CloseableList(list):
 
 __all__.append("BaseWSGIFilter")
 class BaseWSGIFilter:
-    """Generic WSGI filter class to be used with WSGIFilterMiddleware.
+    """Generic WSGI filter class to be used with L{WSGIFilterMiddleware}.
 
     For each request a filter object gets created.
     The environment is then passed through filter_environ.
@@ -145,7 +145,7 @@ class WSGIFilterMiddleware:
     def __init__(self, app, filterclass):
         """
         @param app: is a wsgi application.
-        @type filterclass: BaseWSGIFilters subclass
+        @type filterclass: L{BaseWSGIFilter}s subclass
         @param filterclass: is a subclass of BaseWSGIFilter or some class that
                     implements the interface."""
         self.app = app
diff --git a/wsgitools/middlewares.py b/wsgitools/middlewares.py
index eb7b913..96c148e 100644
--- a/wsgitools/middlewares.py
+++ b/wsgitools/middlewares.py
@@ -199,7 +199,7 @@ class CachingMiddleware:
         @param app: is a wsgi application to be cached.
         @type maxage: number
         @param maxage: is the number of seconds a reponse may be cached.
-        @param storable: is a predicated that determines whether the response
+        @param storable: is a predicate that determines whether the response
                 may be cached at all based on the environ dict.
         @param cacheable: is a predicate that determines whether this request
                 invalidates the cache."""
-- 
cgit v1.2.3