# HG changeset patch # User Pawel Solyga # Date 1228598867 0 # Node ID 46db8c4bbffc11ed4871b07ed757e349581081d4 # Parent 125cad9596daac5e57235017f8ec9e110c0cfd15 Add missing dots in docstrings in modules. Patch by: Pawel Solyga diff -r 125cad9596da -r 46db8c4bbffc app/soc/logic/models/base.py --- a/app/soc/logic/models/base.py Sat Dec 06 21:05:17 2008 +0000 +++ b/app/soc/logic/models/base.py Sat Dec 06 21:27:47 2008 +0000 @@ -66,21 +66,21 @@ self._skip_properties = [] def getModel(self): - """Returns the model this logic class uses + """Returns the model this logic class uses. """ return self._model def getScopeLogic(self): - """Returns the logic of the enclosing scope + """Returns the logic of the enclosing scope. """ return self._scope_logic def getScopeDepth(self): - """Returns the scope depth for this entity + """Returns the scope depth for this entity. - Returns None if any of the parent scopes return None + Returns None if any of the parent scopes return None. """ if not self._scope_logic: @@ -270,7 +270,7 @@ raise out_of_band.Error(msg, status=404) def getIfFields(self, fields): - """Like getFromFieldsOr404 but returns None if not all fields are set + """Like getFromFieldsOr404 but returns None if not all fields are set. Raises: out_of_band.Error if no User entity is found and all fields were set diff -r 125cad9596da -r 46db8c4bbffc app/soc/logic/models/linkable.py --- a/app/soc/logic/models/linkable.py Sat Dec 06 21:05:17 2008 +0000 +++ b/app/soc/logic/models/linkable.py Sat Dec 06 21:27:47 2008 +0000 @@ -41,7 +41,7 @@ super(Logic, self).__init__(soc.models.linkable.Linkable) def getScopeDepth(self): - """Returns the scope depth for this entity + """Returns the scope depth for this entity. As it is impossible to determine the scope depth of a Linkable, None is returned. This causes the scope regexp to match a scope diff -r 125cad9596da -r 46db8c4bbffc app/soc/views/helper/params.py --- a/app/soc/views/helper/params.py Sat Dec 06 21:05:17 2008 +0000 +++ b/app/soc/views/helper/params.py Sat Dec 06 21:27:47 2008 +0000 @@ -45,7 +45,7 @@ def constructParams(params): - """Constructs a new params dictionary based on params + """Constructs a new params dictionary based on params. Params usage: The params dictionary is passed to getCreateForm and getEditForm, @@ -258,7 +258,7 @@ return result def getScopePattern(params): - """Returns the Scope pattern for this entity + """Returns the Scope pattern for this entity. """ logic = params['logic']