summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSviatoslav Sydorenko <wk@sydorenko.org.ua>2016-02-21 00:39:24 +0200
committerSviatoslav Sydorenko <wk@sydorenko.org.ua>2016-02-21 00:39:24 +0200
commita1b865923ddf488d87a5f21e335563a5bc7b163b (patch)
tree9e14ebffc66c0adf3f4a5f17528742d8a7282a57
parent44eca8e5abb5e070eb16ea13e6c2ad9e03ac7fcf (diff)
downloadroutes-a1b865923ddf488d87a5f21e335563a5bc7b163b.tar.gz
Document possibility of depending on [middleware]. Fix #38
-rw-r--r--docs/modules/middleware.rst1
-rw-r--r--routes/middleware.py7
2 files changed, 6 insertions, 2 deletions
diff --git a/docs/modules/middleware.rst b/docs/modules/middleware.rst
index eef80a8..9b12e79 100644
--- a/docs/modules/middleware.rst
+++ b/docs/modules/middleware.rst
@@ -2,7 +2,6 @@
==================================================
.. automodule:: routes.middleware
-.. currentmodule:: routes.middleware
Module Contents
---------------
diff --git a/routes/middleware.py b/routes/middleware.py
index 850e06e..885b9d9 100644
--- a/routes/middleware.py
+++ b/routes/middleware.py
@@ -12,7 +12,12 @@ log = logging.getLogger('routes.middleware')
class RoutesMiddleware(object):
"""Routing middleware that handles resolving the PATH_INFO in
- addition to optionally recognizing method overriding."""
+ addition to optionally recognizing method overriding.
+
+ .. Note::
+ This module requires webob to be installed. To depend on it, you may
+ list routes[middleware] in your ``requirements.txt``
+ """
def __init__(self, wsgi_app, mapper, use_method_override=True,
path_info=True, singleton=True):
"""Create a Route middleware object