update BasicAuthMiddleware docs to reflect api change

1 files changed, 4 insertions, 3 deletions

diff --git a/wsgitools/middlewares.py b/wsgitools/middlewares.py
index 96c148e..57e5028 100644
--- a/wsgitools/middlewares.py
+++ b/wsgitools/middlewares.py
@@ -275,9 +275,10 @@ class BasicAuthMiddleware:
     def __init__(self, app, check_function, realm='www'):
         """
         @param app: is a WSGI application.
-        @param check_function: is a function taking two arguments username and
-                password returning a bool indicating whether the request may is
-                allowed.
+        @param check_function: is a function taking three arguments username,
+                password and environment returning a bool indicating whether the
+                request may is allowed. The older interface of taking only the
+                first two arguments is still supported via catching a TypeError.
         @type realm: str
         """
         self.app = app