summaryrefslogtreecommitdiff
path: root/grc/gui/Param.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/gui/Param.py
parent3e46aef392ba9b2e63bbfefefdb7178cc87049ab (diff)
docs: Modified argument formating in python docstrings in grc.
Diffstat (limited to 'grc/gui/Param.py')
-rw-r--r--grc/gui/Param.py8
1 files changed, 6 insertions, 2 deletions
diff --git a/grc/gui/Param.py b/grc/gui/Param.py
index cb6c663e30..da76b6b82c 100644
--- a/grc/gui/Param.py
+++ b/grc/gui/Param.py
@@ -175,7 +175,9 @@ class Param(Element):
An enum requires and combo parameter.
A non-enum with options gets a combined entry/combo parameter.
All others get a standard entry parameter.
- @return gtk input class
+
+ Returns:
+ gtk input class
"""
if self.is_enum(): return EnumParam(self, *args, **kwargs)
if self.get_options(): return EnumEntryParam(self, *args, **kwargs)
@@ -184,6 +186,8 @@ class Param(Element):
def get_markup(self):
"""
Get the markup for this param.
- @return a pango markup string
+
+ Returns:
+ a pango markup string
"""
return Utils.parse_template(PARAM_MARKUP_TMPL, param=self)