BasicAuthMiddleware docstring: mention REMOTE_USER

1 files changed, 3 insertions, 1 deletions

diff --git a/wsgitools/middlewares.py b/wsgitools/middlewares.py
index 709304f..c3f2871 100644
--- a/wsgitools/middlewares.py
+++ b/wsgitools/middlewares.py
@@ -313,7 +313,9 @@ class DictAuthChecker:
 
 __all__.append("BasicAuthMiddleware")
 class BasicAuthMiddleware:
-    """Middleware implementing HTTP Basic Auth."""
+    """Middleware implementing HTTP Basic Auth. Upon forwarding the request to
+    the warpped application the environ dictionary is augmented by a REMOTE_USER
+    key."""
     def __init__(self, app, check_function, realm='www', app401=None):
         """
         @param app: is a WSGI application.