[5/6] git commit: [#7029] ticket:521 Improve docstring for additional_urls

[jo...@apache.org]

[#7029] ticket:521 Improve docstring for additional_urls


Project: http://git-wip-us.apache.org/repos/asf/incubator-allura/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-allura/commit/a738f1be
Tree: http://git-wip-us.apache.org/repos/asf/incubator-allura/tree/a738f1be
Diff: http://git-wip-us.apache.org/repos/asf/incubator-allura/diff/a738f1be

Branch: refs/heads/master
Commit: a738f1be7edb4fa85e1604e1504599031070a58d
Parents: 663ceca
Author: Igor Bondarenko <je...@gmail.com>
Authored: Mon Feb 24 10:57:47 2014 +0000
Committer: Cory Johns <cj...@slashdotmedia.com>
Committed: Thu Feb 27 21:15:21 2014 +0000

----------------------------------------------------------------------
 Allura/allura/lib/plugin.py | 9 ++++++++-
 1 file changed, 8 insertions(+), 1 deletion(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-allura/blob/a738f1be/Allura/allura/lib/plugin.py
----------------------------------------------------------------------
diff --git a/Allura/allura/lib/plugin.py b/Allura/allura/lib/plugin.py
index 072d829..cfd9170 100644
--- a/Allura/allura/lib/plugin.py
+++ b/Allura/allura/lib/plugin.py
@@ -985,7 +985,14 @@ class UserPreferencesProvider(object):
 
     def additional_urls(self):
         '''
-        :return: [[str url, function], ]
+        Returns list of additional routes for AuthProvider.
+
+        No additional routes by default. Subclasses migth override this.
+
+        For example: [('newroute', newroute_handler), ] will add
+        'newroute' attribute to AuthProvider, which will be set to newroute_handler.
+
+        newroutehandler is a usual controller method (decorated with @exposed and other stuff).
         '''
         return []