summaryrefslogtreecommitdiff
path: root/grc/base/Element.py
diff options
context:
space:
mode:
authorBen Reynwar <ben@reynwar.net>2012-08-14 10:28:23 -0700
committerBen Reynwar <ben@reynwar.net>2012-08-14 10:28:23 -0700
commitfc4d37062c46886d3bc1fb0b6c3626d779be4ecd (patch)
treee69367ce9284b7a91c31899f66d129d2a9bccae6 /grc/base/Element.py
parent3e46aef392ba9b2e63bbfefefdb7178cc87049ab (diff)
docs: Modified argument formating in python docstrings in grc.
Diffstat (limited to 'grc/base/Element.py')
-rw-r--r--grc/base/Element.py12
1 files changed, 9 insertions, 3 deletions
diff --git a/grc/base/Element.py b/grc/base/Element.py
index a57090f3b2..74097eea9a 100644
--- a/grc/base/Element.py
+++ b/grc/base/Element.py
@@ -36,14 +36,18 @@ class Element(object):
def is_valid(self):
"""
Is this element valid?
- @return true when the element is enabled and has no error messages
+
+ Returns:
+ true when the element is enabled and has no error messages
"""
return not self.get_error_messages() or not self.get_enabled()
def add_error_message(self, msg):
"""
Add an error message to the list of errors.
- @param msg the error message string
+
+ Args:
+ msg: the error message string
"""
self._error_messages.append(msg)
@@ -52,7 +56,9 @@ class Element(object):
Get the list of error messages from this element and all of its children.
Do not include the error messages from disabled children.
Cleverly indent the children error messages for printing purposes.
- @return a list of error message strings
+
+ Returns:
+ a list of error message strings
"""
error_messages = list(self._error_messages) #make a copy
for child in filter(lambda c: c.get_enabled(), self.get_children()):