# HG changeset patch # User Pawel Solyga # Date 1228134895 0 # Node ID 86ec079d8302201ecd5f44a0335223dfa8d1835f # Parent 66e3dd913057f0b1264a03dbc911a4cb06ecdc74 Some docstring and missing blank lines fixes in soc.views.sitemap modules. Patch by: Pawel Solyga diff -r 66e3dd913057 -r 86ec079d8302 app/soc/views/sitemap/sidebar.py --- a/app/soc/views/sitemap/sidebar.py Sun Nov 30 22:30:01 2008 +0000 +++ b/app/soc/views/sitemap/sidebar.py Mon Dec 01 12:34:55 2008 +0000 @@ -14,7 +14,7 @@ # See the License for the specific language governing permissions and # limitations under the License. -"""Sidebar +"""Module contains sidebar related functions. """ __authors__ = [ @@ -25,6 +25,7 @@ from soc.views import out_of_band from soc.views.helper import access + SIDEBAR = [] @@ -46,7 +47,7 @@ def getSidebarItems(params): - """Retrieves a list of sidebar entries for this view + """Retrieves a list of sidebar entries for this view. Params usage: The params dictionary is provided to the menu_text's format. @@ -98,7 +99,7 @@ Params usage: The params dictionary is passed as argument to getSidebarItems, - see the docstring of getSidebarItems on how it uses it. + see the docstring of getSidebarItems on how it uses it. rights: The rights dictionary is used to check if the user has the required rights to see a sidebar item. @@ -108,10 +109,10 @@ heading variable in the result. name: The name value is used if sidebar_heading is not present. - Returns: A dictionary is returned with it's 'heading' value set - as explained above. It's 'items' value is constructed by - calling _getSidebarItems. It constists of dictionaries with a - url and a title field. + Returns: + A dictionary is returned with it's 'heading' value set as explained above. + It's 'items' value is constructed by calling _getSidebarItems. It constists + of dictionaries with a url and a title field. """ rights = params['rights'] diff -r 66e3dd913057 -r 86ec079d8302 app/soc/views/sitemap/sitemap.py --- a/app/soc/views/sitemap/sitemap.py Sun Nov 30 22:30:01 2008 +0000 +++ b/app/soc/views/sitemap/sitemap.py Mon Dec 01 12:34:55 2008 +0000 @@ -14,7 +14,7 @@ # See the License for the specific language governing permissions and # limitations under the License. -"""Sidebar +"""Module contains sidemap related functions. """ __authors__ = [ @@ -31,11 +31,12 @@ def getDjangoURLPatterns(params): - """Retrieves a list of sidebar entries for this View + """Retrieves a list of sidebar entries for this View. Params usage: The params dictionary is passed to the getKeyFieldsPatterns - method, see it's docstring on how it is used. + method, see it's docstring on how it is used. + django_patterns: The django_patterns value is returned directly if it is non-False. django_patterns_defaults: The dajngo_patterns_defaults value is