Add import note to warn about recursive import case

diff --git a/README.rst b/README.rst
index c08f2af10bfa5c098db892a13c8d08623ee45794..f68b6b516deab69295c571abf8125459e908a7a2 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -553,6 +553,11 @@ South_ users should add this rule to enable migrations::
         pass
 
 
+If defining a custom user model, do not import social_auth from any models.py
+that would finally import from the models.py that defines your User class or it
+will make your project fail with a recursive import because social_auth uses
+get_model() to retrieve your User.
+
 ----
 Bugs
 ----

diff --git a/doc/miscellaneous.rst b/doc/miscellaneous.rst
index c07a569f104b1218285e741b846ffef8007e632f..9a366fc856293ce200017a368e55599916179a6a 100644 (file)
--- a/doc/miscellaneous.rst
+++ b/doc/miscellaneous.rst
@@ -14,6 +14,10 @@ South_ users should add this rule to enable migrations::
     except:
         pass
 
+If defining a custom user model, do not import social_auth from any models.py
+that would finally import from the models.py that defines your User class or it
+will make your project fail with a recursive import because social_auth uses
+get_model() to retrieve your User.
 
 .. _South: http://south.aeracode.org/
 .. _django-social-auth: https://convore.com/django-social-auth/