Add missing dots in docstrings, proper sorting of imports and small docstring typo fixes.
Patch by: Pawel Solyga
--- a/app/soc/views/helper/access.py Sun Dec 07 20:02:40 2008 +0000
+++ b/app/soc/views/helper/access.py Sun Dec 07 20:25:50 2008 +0000
@@ -318,12 +318,12 @@
def checkIsDocumentPublic(request):
- """Checks whether a document is public
+ """Checks whether a document is public.
Args:
request: a Django HTTP request
"""
- # TODO: A proper check needs to be done to see if the document
+ # TODO(srabbelier): A proper check needs to be done to see if the document
# is public or not, probably involving analysing it's scope or such.
allow(request)
--- a/app/soc/views/models/base.py Sun Dec 07 20:02:40 2008 +0000
+++ b/app/soc/views/models/base.py Sun Dec 07 20:25:50 2008 +0000
@@ -512,7 +512,7 @@
if not self._params['scope_logic']:
return
- # If this entity is unscoped, to not try to retrieve a scope
+ # If this entity is unscoped, do not try to retrieve a scope
if 'scope_path' not in fields:
return
--- a/app/soc/views/models/program.py Sun Dec 07 20:02:40 2008 +0000
+++ b/app/soc/views/models/program.py Sun Dec 07 20:25:50 2008 +0000
@@ -34,8 +34,8 @@
from soc.views.helper import access
from soc.views.helper import redirects
from soc.views.models import base
+from soc.views.models import document as document_view
from soc.views.models import sponsor as sponsor_view
-from soc.views.models import document as document_view
from soc.views.sitemap import sidebar
import soc.logic.models.program
--- a/app/soc/views/sitemap/sidebar.py Sun Dec 07 20:02:40 2008 +0000
+++ b/app/soc/views/sitemap/sidebar.py Sun Dec 07 20:25:50 2008 +0000
@@ -39,7 +39,7 @@
SIDEBAR.append(callback)
def getSidebar(request):
- """Constructs a sidebar for the specified request
+ """Constructs a sidebar for the specified request.
"""
sidebar = []
@@ -100,8 +100,8 @@
raises out_of_band.Error, the item will not be added.
Args:
+ request: the django request object
items: see above
- request: the django request object
params: a dict with params for this View
Params usage: