From 4ab344563147647dfd997b331d22ef096fcf7d54 Mon Sep 17 00:00:00 2001 From: Bradley Gordon Date: Thu, 2 Apr 2015 09:52:29 -0600 Subject: [PATCH] Add suggestion in backends docs, fix typo in backends.py --- authtools/backends.py | 2 +- docs/backends.rst | 4 +++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/authtools/backends.py b/authtools/backends.py index 40109dc..ea40065 100644 --- a/authtools/backends.py +++ b/authtools/backends.py @@ -16,7 +16,7 @@ def authenticate(self, username=None, password=None, **kwargs): A word of caution. Use of this backend presupposes a way to ensure that users cannot create usernames that differ only in case (e.g., joe@test.org and JOE@test.org). It is advised that you use this backend in conjunction with the - EmailInsensitiveCreateUserForm provided in the forms module. + CaseInsensitiveEmailUserCreationForm provided in the forms module. """ if username is not None: username = username.lower() diff --git a/docs/backends.rst b/docs/backends.rst index 5632c1c..0203570 100644 --- a/docs/backends.rst +++ b/docs/backends.rst @@ -15,7 +15,9 @@ for how your :class:`authtool.models.User` class is authenticated. .. warning: Use of this mixin presupposes that all usernames are stored in their lowercase form, and that there is no way to have usernames differing only in case. If usernames can differ in - case, this authentication backend mixin could cause errors in user authentication. + case, this authentication backend mixin could cause errors in user authentication. It is + advised that you use this mixin in conjuction with the + ``CaseInsensitiveEmailUserCreationForm`` form provided in the ``forms`` module. .. class:: CaseInsensitiveEmailModelBackend A subclass of the ``CaseInsentiveEmailBackendMixin`` with