From 6e91c115ce8923242b0563655c59e328c3e54ef6 Mon Sep 17 00:00:00 2001
From: Raphael Michel <mail@raphaelmichel.de>
Date: Fri, 12 Sep 2014 16:24:17 +0200
Subject: [PATCH] Login view doc

---
 src/tixlcontrol/views/auth.py | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)

diff --git a/src/tixlcontrol/views/auth.py b/src/tixlcontrol/views/auth.py
index 51505b5c6b..d6b812c063 100644
--- a/src/tixlcontrol/views/auth.py
+++ b/src/tixlcontrol/views/auth.py
@@ -8,7 +8,8 @@ from django.contrib.auth import login as auth_login
 
 class AuthenticationForm(BaseAuthenticationForm):
     """
-    The login form.
+    The login form, providing an email and password field. The
+    form does already implement validation for correct user data.
     """
     email = forms.EmailField(label=_("E-mail address"), max_length=254)
     password = forms.CharField(label=_("Password"), widget=forms.PasswordInput)
@@ -43,6 +44,10 @@ class AuthenticationForm(BaseAuthenticationForm):
 
 
 def login(request):
+    """
+    Render and process a most basic login form. Takes an URL as GET
+    parameter "next" for redirection after successful login
+    """
     ctx = {}
     if request.user.is_authenticated():
         if "next" in request.GET: