summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--docs/DeveloperGuidelines.txt2
-rw-r--r--paste/auth/__init__.py4
-rw-r--r--paste/debug/__init__.py4
-rw-r--r--paste/evalexception/__init__.py3
-rw-r--r--paste/exceptions/__init__.py5
-rw-r--r--paste/fixture.py3
-rw-r--r--paste/lint.py3
-rw-r--r--paste/printdebug.py5
-rw-r--r--paste/profilemiddleware.py5
-rw-r--r--paste/recursive.py3
-rw-r--r--paste/response.py4
-rw-r--r--paste/translogger.py4
-rw-r--r--paste/urlparser.py3
-rw-r--r--paste/util/__init__.py5
-rw-r--r--paste/wdg_validate.py5
15 files changed, 53 insertions, 5 deletions
diff --git a/docs/DeveloperGuidelines.txt b/docs/DeveloperGuidelines.txt
index 92747fc..7b88966 100644
--- a/docs/DeveloperGuidelines.txt
+++ b/docs/DeveloperGuidelines.txt
@@ -98,7 +98,7 @@ is going to bite your head off for committing something.
from docstrings.
The generation is done with `Pudge <http://pudge.lesscode.org/>`_.
- To try generating the documentation, this should work:
+ To try generating the documentation, this should work::
$ easy_install svn://lesscode.org/buildutils/trunk \
svn://lesscode.org/pudge/trunk
diff --git a/paste/auth/__init__.py b/paste/auth/__init__.py
index 792d600..76835b0 100644
--- a/paste/auth/__init__.py
+++ b/paste/auth/__init__.py
@@ -1 +1,3 @@
-#
+"""
+Package for authentication/identification of requests.
+"""
diff --git a/paste/debug/__init__.py b/paste/debug/__init__.py
index 792d600..ed5577a 100644
--- a/paste/debug/__init__.py
+++ b/paste/debug/__init__.py
@@ -1 +1,3 @@
-#
+"""
+Package for debugging and development tools
+"""
diff --git a/paste/evalexception/__init__.py b/paste/evalexception/__init__.py
index c13de4d..5f6dd4f 100644
--- a/paste/evalexception/__init__.py
+++ b/paste/evalexception/__init__.py
@@ -1,2 +1,5 @@
+"""
+An exception handler for interactive debugging
+"""
from middleware import EvalException
diff --git a/paste/exceptions/__init__.py b/paste/exceptions/__init__.py
index 792d600..3996c70 100644
--- a/paste/exceptions/__init__.py
+++ b/paste/exceptions/__init__.py
@@ -1 +1,4 @@
-#
+"""
+Package for catching exceptions and displaying annotated exception
+reports
+"""
diff --git a/paste/fixture.py b/paste/fixture.py
index b242aa5..bf1ef18 100644
--- a/paste/fixture.py
+++ b/paste/fixture.py
@@ -1,5 +1,8 @@
# (c) 2005 Ian Bicking and contributors; written for Paste (http://pythonpaste.org)
# Licensed under the MIT license: http://www.opensource.org/licenses/mit-license.php
+"""
+Routines for testing WSGI applications.
+"""
import sys
import random
diff --git a/paste/lint.py b/paste/lint.py
index 496ab6e..079ceb5 100644
--- a/paste/lint.py
+++ b/paste/lint.py
@@ -1,5 +1,8 @@
# (c) 2005 Ian Bicking and contributors; written for Paste (http://pythonpaste.org)
# Licensed under the MIT license: http://www.opensource.org/licenses/mit-license.php
+"""
+Middleware to check for obedience to the WSGI specification.
+"""
import re
import sys
diff --git a/paste/printdebug.py b/paste/printdebug.py
index 3e0a0d2..92db940 100644
--- a/paste/printdebug.py
+++ b/paste/printdebug.py
@@ -1,7 +1,12 @@
# Deprecated 18 Dec 2005
+"""
+Deprecated -- see ``paste.debug.prints``
+"""
import warnings
from paste.debug.prints import *
+__deprecated__ = True
+
warnings.warn(
"The paste.printdebug module has been moved to "
"paste.debug.prints",
diff --git a/paste/profilemiddleware.py b/paste/profilemiddleware.py
index d40364a..f097921 100644
--- a/paste/profilemiddleware.py
+++ b/paste/profilemiddleware.py
@@ -1,7 +1,12 @@
# Deprecated 18 Dec 2005
+"""
+Deprecated -- see ``paste.debug.profile``
+"""
import warnings
from paste.debug.profile import *
+__deprecated__ = True
+
warnings.warn(
"The paste.profilemiddleware module has been moved to "
"paste.debug.profile",
diff --git a/paste/recursive.py b/paste/recursive.py
index bfd25de..2cc6f8a 100644
--- a/paste/recursive.py
+++ b/paste/recursive.py
@@ -1,5 +1,8 @@
# (c) 2005 Ian Bicking and contributors; written for Paste (http://pythonpaste.org)
# Licensed under the MIT license: http://www.opensource.org/licenses/mit-license.php
+"""
+Middleware to make internal requests and forward requests internally.
+"""
from cStringIO import StringIO
diff --git a/paste/response.py b/paste/response.py
index 9547db8..85deb6d 100644
--- a/paste/response.py
+++ b/paste/response.py
@@ -1,3 +1,7 @@
+"""
+Routines to generate WSGI responses
+"""
+
############################################################
## Headers
############################################################
diff --git a/paste/translogger.py b/paste/translogger.py
index bafc79f..e47ec31 100644
--- a/paste/translogger.py
+++ b/paste/translogger.py
@@ -1,3 +1,7 @@
+"""
+Middleware for logging requests, using Apache combined log format
+"""
+
import logging
import time
diff --git a/paste/urlparser.py b/paste/urlparser.py
index e948a52..671bb8c 100644
--- a/paste/urlparser.py
+++ b/paste/urlparser.py
@@ -1,5 +1,8 @@
# (c) 2005 Ian Bicking and contributors; written for Paste (http://pythonpaste.org)
# Licensed under the MIT license: http://www.opensource.org/licenses/mit-license.php
+"""
+WSGI applications that parse the URL and dispatch to on-disk resources
+"""
import os
import sys
diff --git a/paste/util/__init__.py b/paste/util/__init__.py
index 792d600..ea4ff1e 100644
--- a/paste/util/__init__.py
+++ b/paste/util/__init__.py
@@ -1 +1,4 @@
-#
+"""
+Package for miscellaneous routines that do not depend on other parts
+of Paste
+"""
diff --git a/paste/wdg_validate.py b/paste/wdg_validate.py
index bd791f5..6033741 100644
--- a/paste/wdg_validate.py
+++ b/paste/wdg_validate.py
@@ -1,7 +1,12 @@
# Deprecated 18 Dec 2005
+"""
+Deprecated -- see ``paste.debug.wdg_validate``
+"""
import warnings
from paste.debug.wdg_validate import *
+__deprecated__ = True
+
warnings.warn(
"The paste.wdg_validate module has been moved to "
"paste.debug.wdg_validate",