From 94bfdfa68e0dc349e58e7172f5518f40538e81fd Mon Sep 17 00:00:00 2001 From: =?utf8?q?Mat=C3=ADas=20Aguirre?= Date: Sun, 5 Feb 2012 22:20:03 -0200 Subject: [PATCH] Deprecated settings doc --- README.rst | 33 +++++++++++++++++++++++++++++++++ doc/deprecated.rst | 32 ++++++++++++++++++++++++++++++++ doc/index.rst | 2 ++ doc/pipeline.rst | 3 +++ 4 files changed, 70 insertions(+) create mode 100644 doc/deprecated.rst diff --git a/README.rst b/README.rst index 351f3ae..226906b 100644 --- a/README.rst +++ b/README.rst @@ -374,6 +374,39 @@ If any function returns something else beside a ``dict`` or ``None``, the workflow will be cut and the value returned immediately, this is useful to return ``HttpReponse`` instances like ``HttpResponseRedirect``. +--------------- +Deprecated bits +--------------- + +The following settings are deprecated in favor of pipeline functions. + +- These settings should be avoided and override ``get_username`` pipeline entry + with the desired behavior:: + + SOCIAL_AUTH_FORCE_RANDOM_USERNAME + SOCIAL_AUTH_DEFAULT_USERNAME + SOCIAL_AUTH_UUID_LENGTH + SOCIAL_AUTH_USERNAME_FIXER + +- User creation setting should be avoided and remove the entry ``create_user`` + from pipeline instead:: + + SOCIAL_AUTH_CREATE_USERS + +- Automatic data update should be stopped by overriding ``update_user_details`` + pipeline entry instead of using this setting:: + + SOCIAL_AUTH_CHANGE_SIGNAL_ONLY + +- Extra data retrieval from providers should be stopped by removing + ``load_extra_data`` from pipeline instead of using this setting:: + + SOCIAL_AUTH_EXTRA_DATA + +- Automatic email association should be avoided by removing + ``associate_by_email`` pipeline entry instead of using this setting:: + + SOCIAL_AUTH_ASSOCIATE_BY_MAIL ------------- Usage example diff --git a/doc/deprecated.rst b/doc/deprecated.rst new file mode 100644 index 0000000..60d3ff6 --- /dev/null +++ b/doc/deprecated.rst @@ -0,0 +1,32 @@ +Deprecated bits +=============== + +The following settings are deprecated in favor of pipeline functions. + +- These settings should be avoided and override ``get_username`` pipeline entry + with the desired behavior:: + + SOCIAL_AUTH_FORCE_RANDOM_USERNAME + SOCIAL_AUTH_DEFAULT_USERNAME + SOCIAL_AUTH_UUID_LENGTH + SOCIAL_AUTH_USERNAME_FIXER + +- User creation setting should be avoided and remove the entry ``create_user`` + from pipeline instead:: + + SOCIAL_AUTH_CREATE_USERS + +- Automatic data update should be stopped by overriding ``update_user_details`` + pipeline entry instead of using this setting:: + + SOCIAL_AUTH_CHANGE_SIGNAL_ONLY + +- Extra data retrieval from providers should be stopped by removing + ``load_extra_data`` from pipeline instead of using this setting:: + + SOCIAL_AUTH_EXTRA_DATA + +- Automatic email association should be avoided by removing + ``associate_by_email`` pipeline entry instead of using this setting:: + + SOCIAL_AUTH_ASSOCIATE_BY_MAIL diff --git a/doc/index.rst b/doc/index.rst index 0e05651..68921ae 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -16,6 +16,8 @@ Contents: backends/index pipeline + pipeline + deprecated signals contributions diff --git a/doc/pipeline.rst b/doc/pipeline.rst index 6c9d543..d8c9f94 100644 --- a/doc/pipeline.rst +++ b/doc/pipeline.rst @@ -51,3 +51,6 @@ is raised at any point. If any function returns something else beside a ``dict`` or ``None``, the workflow will be cut and the value returned immediately, this is useful to return ``HttpReponse`` instances like ``HttpResponseRedirect``. + + +.. _django-social-auth: https://github.com/omab/django-social-auth -- 2.39.5