[Python-modules-commits] [python-social-auth] 126/322: Don't use "import" in example method paths docs to avoid confusion

[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 54310a5d4b8a0e6a40106ec3b47d20ad7c87fc7e
Author: Chris Lamb <chris at chris-lamb.co.uk>
Date:   Mon Feb 16 19:13:43 2015 +0000

    Don't use "import" in example method paths docs to avoid confusion
    
    This is for two reasons:
    
     a) Using the verb "import" suggests that the module/function should be
        imported which is not true; we want a "dotted path notation" string
        rather than a reference to the method.
    
     b) "import" is an invalid module name anyway, so as an example of dotted
        path notation it is faulty. (Okay, it might actually be possible using
        `types` and `sys.modules` but.. yeah)
    
    Signed-off-by: Chris Lamb <chris at chris-lamb.co.uk>
---
 docs/pipeline.rst  | 2 +-
 docs/use_cases.rst | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/docs/pipeline.rst b/docs/pipeline.rst
index 4e5b9ac..64e65fb 100644
--- a/docs/pipeline.rst
+++ b/docs/pipeline.rst
@@ -330,7 +330,7 @@ the pipeline, since it needs the user instance, it needs to be put after
         'social.pipeline.social_auth.social_user',
         'social.pipeline.user.get_username',
         'social.pipeline.user.create_user',
-        'import.path.to.save_profile',  # <--- set the import-path to the function
+        'path.to.save_profile',  # <--- set the path to the function
         'social.pipeline.social_auth.associate_user',
         'social.pipeline.social_auth.load_extra_data',
         'social.pipeline.user.user_details'
diff --git a/docs/use_cases.rst b/docs/use_cases.rst
index 3ba1cad..ac12fa2 100644
--- a/docs/use_cases.rst
+++ b/docs/use_cases.rst
@@ -287,7 +287,7 @@ Set this pipeline after ``social_user``::
         'social.pipeline.social_auth.social_uid',
         'social.pipeline.social_auth.auth_allowed',
         'social.pipeline.social_auth.social_user',
-        'import.path.to.redirect_if_no_refresh_token',
+        'path.to.redirect_if_no_refresh_token',
         'social.pipeline.user.get_username',
         'social.pipeline.user.create_user',
         'social.pipeline.social_auth.associate_user',

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