py_tasks_melange: comparison app/soc/views/models/base.py

equal deleted inserted replaced

-:22ec01fdf8f4
+:1f92bd41b914
 return self.editPost(request, entity, context, params)
 else:
 return self.editGet(request, entity, context, seed, params)
 def editPost(self, request, entity, context, params):
-"""Processes POST requests for the specified entity
+"""Processes POST requests for the specified entity.
 Params usage:
 The params dictionary is passed to _constructResponse when the
 form is not valid (see edit_form and create_form below). See
 the docstring of _constructResponse on how it uses it.
 return helper.responses.redirectToChangedSuffix(
 request, None, new_suffix,
 params=page_params)
 def editGet(self, request, entity, context, seed, params):
-"""Processes GET requests for the specified entity
+"""Processes GET requests for the specified entity.
 Params usage:
 The params dictionary is passed to _constructResponse, see the
 docstring  of _constructResponse on how it uses it.
 save_message: The save_message list is used as argument to
 getSingleIndexedParamValue when an existing entity was saved.
 edit_form: The edit_form is used as form if there is an existing
 entity. The existing entity is passed as instance to it on
 params: a dict with params for this View
 filter: a dict for the properties that the entities should have
 Params usage:
 The params dictionary is passed as argument to getListContent in
-the soc.views.helper.list module. See the docstring for
+the soc.views.helper.list module. See the docstring for getListContent
-getListContent on how it uses it.
+on how it uses it. The params dictionary is also passed as argument to
-The params dictionary is also passed as argument to the _list
+the _list method. See the docstring for _list on how it uses it.
-method. See the docstring for _list on how it uses it.
 rights: The rights dictionary is used to check if the user has
 the required rights to list all entities of this View's type.
 See checkAccess for more details on how the rights dictionary
 is used to check access rights.
 contents = [content]
 return self._list(request, params, contents, page_name)
 def _list(self, request, params, contents, page_name):
-"""Returns the list page for the specified contents
+"""Returns the list page for the specified contents.
 Args:
 request: the standard Django HTTP request object
 params: a dict with params for this View
 contents: a list of content dicts
 params: a dict with params for this View
 kwargs: The Key Fields for the specified entity
 Params usage:
 rights: The rights dictionary is used to check if the user has
-the required rights to delete the specified entity.
+the required rights to delete the specified entity. See checkAccess
-See checkAccess for more details on how the rights dictionary
+for more details on how the rights dictionary is used to check access
-is used to check access rights.
+rights.
 name: used in the same way as in edit(), see it's docstring for
 a more detailed explanation on how it is used.
 missing_redirect: see name
 error_edit: see name
 delete_redirect: The delete_redirect value is used as the url to
 def _editPost(self, request, entity, fields):
 """Performs any required processing on the entity to post its edit page.
 Args:
 request: the django request object
-entity:  the entity to create or update from POST contents
+entity: the entity to create or update from POST contents
 fields: the new field values
 """
 pass
 request: the django request object
 params: a dict with params for this View
 Params usage:
 The params dictionary is passed as argument to getSidebarItems
 from the soc.views.sitemap.sidebar module, see the docstring
 of _getSidebarItems on how it uses it.
 """
 params = dicts.merge(params, self._params)
 return sitemap.sidebar.getSidebarLinks(request, params)
 def getDjangoURLPatterns(self, params=None):
 """Retrieves a list of sidebar entries for this view
 Params usage:
 The params dictionary is passed to the getDjangoURLPatterns
 function in the soc.views.sitemap.sitemap module, see the
 docstring of getDjangoURLPatterns on how it uses it.
 Args:
 params: a dict with params for this View
 """

changeset 639	1f92bd41b914
parent 632	1f20cfb91e11
child 646	860e17e5118f