[Python-modules-commits] [python-social-auth] 229/322: Update docs about SOCIAL_AUTH_PROTECTED_USER_FIELDS. Fixes #459

[Wolfgang Borgert]

This is an automated email from the git hooks/post-receive script.

debacle pushed a commit to tag v0.2.10
in repository python-social-auth.

commit 8aab8099a2345ccf7deaa358da3d45e1af9ef8f7
Author: Matías Aguirre <matiasaguirre at gmail.com>
Date:   Sat Apr 4 03:08:04 2015 -0300

    Update docs about SOCIAL_AUTH_PROTECTED_USER_FIELDS. Fixes #459
---
 docs/configuration/settings.rst | 11 +++++++----
 1 file changed, 7 insertions(+), 4 deletions(-)

diff --git a/docs/configuration/settings.rst b/docs/configuration/settings.rst
index c0bf743..a67ddb2 100644
--- a/docs/configuration/settings.rst
+++ b/docs/configuration/settings.rst
@@ -255,9 +255,13 @@ Miscellaneous settings
 ----------------------
 
 ``SOCIAL_AUTH_PROTECTED_USER_FIELDS = ['email',]``
-    The `user_details` pipeline processor will set certain fields on user
-    objects, such as ``email``. Set this to a list of fields you only want to
-    set for newly created users and avoid updating on further logins.
+    During the pipeline process a ``dict`` named ``details`` will be populated
+    with the needed values to create the user instance, but it's also used to
+    update the user instance. Any value in it will be checked as an attribute
+    in the user instance (first by doing ``hasattr(user, name)``). Usually
+    there are attributes that cannot be updated (like ``username``, ``id``,
+    ``email``, etc.), those fields need to be *protect*. Set any field name that
+    requires *protection* in this setting, and it won't be updated.
 
 ``SOCIAL_AUTH_SESSION_EXPIRATION = False``
     By default, user session expiration time will be set by your web
@@ -268,7 +272,6 @@ Miscellaneous settings
     web framework's session length setting and set user session lengths to
     match the ``expires`` value from the auth provider.
 
-
 ``SOCIAL_AUTH_OPENID_PAPE_MAX_AUTH_AGE = <int value>``
     Enable `OpenID PAPE`_ extension support by defining this setting.
 

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/python-modules/packages/python-social-auth.git