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/python/Generator.py | 14 ++++++++++----
1 file changed, 10 insertions(+), 4 deletions(-)
(limited to 'grc/python/Generator.py')
diff --git a/grc/python/Generator.py b/grc/python/Generator.py
index 2a6fe51d5d..f8490227a7 100644
--- a/grc/python/Generator.py
+++ b/grc/python/Generator.py
@@ -35,8 +35,10 @@ class Generator(object):
"""
Initialize the generator object.
Determine the file to generate.
- @param flow_graph the flow graph object
- @param file_path the path to write the file to
+
+ Args:
+ flow_graph: the flow graph object
+ file_path: the path to write the file to
"""
self._flow_graph = flow_graph
self._generate_options = self._flow_graph.get_option('generate_options')
@@ -72,7 +74,9 @@ Add a Misc->Throttle block to your flow graph to avoid CPU congestion.''')
def get_popen(self):
"""
Execute this python flow graph.
- @return a popen object
+
+ Returns:
+ a popen object
"""
#extract the path to the python executable
python_exe = sys.executable
@@ -95,7 +99,9 @@ Add a Misc->Throttle block to your flow graph to avoid CPU congestion.''')
def __str__(self):
"""
Convert the flow graph to python code.
- @return a string of python code
+
+ Returns:
+ a string of python code
"""
title = self._flow_graph.get_option('title') or self._flow_graph.get_option('id').replace('_', ' ').title()
imports = self._flow_graph.get_imports()
--
cgit v1.2.3