improved AuthDigestMiddleware doc string

1 files changed, 4 insertions, 1 deletions

diff --git a/wsgitools/digest.py b/wsgitools/digest.py
index bb587fa..2a8da05 100755
--- a/wsgitools/digest.py
+++ b/wsgitools/digest.py
@@ -478,7 +478,10 @@ class DBAPI2NonceStore(NonceStoreBase):
 
 __all__.append("AuthDigestMiddleware")
 class AuthDigestMiddleware:
-    """Middleware partly implementing RFC2617. (md5-sess was omited)"""
+    """Middleware partly implementing RFC2617. (md5-sess was omited)
+    Upon successful authentication the environ dict will be extended
+    by a REMOTE_USER key before being passed to the wrapped
+    application."""
     algorithms = {"md5": lambda data: md5(data).hexdigest()}
     def __init__(self, app, gentoken, maxage=300, maxuses=5, store=None):
         """