From fc4d37062c46886d3bc1fb0b6c3626d779be4ecd Mon Sep 17 00:00:00 2001
From: Ben Reynwar <ben@reynwar.net>
Date: Tue, 14 Aug 2012 10:28:23 -0700
Subject: docs: Modified argument formating in python docstrings in grc.
---
grc/base/Param.py | 14 ++++++++++----
1 file changed, 10 insertions(+), 4 deletions(-)
(limited to 'grc/base/Param.py')
diff --git a/grc/base/Param.py b/grc/base/Param.py
index c2fa5461ae..76a74d3ed7 100644
--- a/grc/base/Param.py
+++ b/grc/base/Param.py
@@ -63,8 +63,10 @@ class Param(Element):
def __init__(self, block, n):
"""
Make a new param from nested data.
- @param block the parent element
- @param n the nested odict
+
+ Args:
+ block: the parent element
+ n: the nested odict
"""
#grab the data
self._name = n.find('name')
@@ -148,7 +150,9 @@ class Param(Element):
Get the repr (nice string format) for this param.
Just return the value (special case enum).
Derived classes can handle complex formatting.
- @return the string representation
+
+ Returns:
+ the string representation
"""
if self.is_enum(): return self.get_option(self.get_value()).get_name()
return self.get_value()
@@ -173,7 +177,9 @@ class Param(Element):
def export_data(self):
"""
Export this param's key/value.
- @return a nested data odict
+
+ Returns:
+ a nested data odict
"""
n = odict()
n['key'] = self.get_key()
--
cgit v1.2.3