Add missing all() __doc__ string comments: "Args:" and "Returns:" sections.
authorTodd Larsen <tlarsen@google.com>
Wed, 01 Oct 2008 05:10:41 +0000
changeset 233 42733f531ebf
parent 232 7741d6b7ce7c
child 234 a019afb4b80f
Add missing all() __doc__ string comments: "Args:" and "Returns:" sections.
app/soc/views/site/user/list.py
--- a/app/soc/views/site/user/list.py	Wed Oct 01 05:02:42 2008 +0000
+++ b/app/soc/views/site/user/list.py	Wed Oct 01 05:10:41 2008 +0000
@@ -33,6 +33,15 @@
 
 def all(request, template=DEF_SITE_USER_LIST_ALL_TMPL):
   """Show a list of all Users (limit rows per page).
+  
+  Args:
+    request: the standard Django HTTP request object
+    template: the "sibling" template (or a search list of such templates)
+      from which to construct an alternate template name (or names)
+
+  Returns:
+    A subclass of django.http.HttpResponse which either contains the form to
+    be filled out, or a redirect to the correct view in the interface.
   """
   # create default template context for use with any templates
   context = response_helpers.getUniversalContext(request)