From: Ben Darnell <ben@bendarnell.com>
Date: Mon, 28 Apr 2014 03:20:16 +0000 (-0400)
Subject: Document @authenticated's behavior around query parameters.
X-Git-Tag: v4.0.0b1~88
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=3d87bf59a24e3a16ff11c6e1d4a3013ab5335938;p=thirdparty%2Ftornado.git

Document @authenticated's behavior around query parameters.

Closes #998.
---

diff --git a/tornado/web.py b/tornado/web.py
index dbd6abf57..2b5e51f21 100644
--- a/tornado/web.py
+++ b/tornado/web.py
@@ -2450,6 +2450,11 @@ def authenticated(method):
 
     If the user is not logged in, they will be redirected to the configured
     `login url <RequestHandler.get_login_url>`.
+
+    If you configure a login url with a query parameter, Tornado will
+    assume you know what you're doing and use it as-is.  If not, it
+    will add a `next` parameter so the login page knows where to send
+    you once you're logged in.
     """
     @functools.wraps(method)
     def wrapper(self, *args, **kwargs):