diff options
| author | Ben Reynwar <ben@reynwar.net> | 2012-08-14 10:28:23 -0700 |
|---|---|---|
| committer | Ben Reynwar <ben@reynwar.net> | 2012-08-14 10:28:23 -0700 |
| commit | fc4d37062c46886d3bc1fb0b6c3626d779be4ecd (patch) | |
| tree | e69367ce9284b7a91c31899f66d129d2a9bccae6 /grc/base/Connection.py | |
| parent | 3e46aef392ba9b2e63bbfefefdb7178cc87049ab (diff) | |
docs: Modified argument formating in python docstrings in grc.
Diffstat (limited to 'grc/base/Connection.py')
| -rw-r--r-- | grc/base/Connection.py | 20 |
1 files changed, 14 insertions, 6 deletions
diff --git a/grc/base/Connection.py b/grc/base/Connection.py index 3ce7fd07f9..b9afe1434d 100644 --- a/grc/base/Connection.py +++ b/grc/base/Connection.py @@ -25,11 +25,15 @@ class Connection(Element): def __init__(self, flow_graph, porta, portb): """ Make a new connection given the parent and 2 ports. - @param flow_graph the parent of this element - @param porta a port (any direction) - @param portb a port (any direction) + + Args: + flow_graph: the parent of this element + porta: a port (any direction) + portb: a port (any direction) @throws Error cannot make connection - @return a new connection + + Returns: + a new connection """ Element.__init__(self, flow_graph) source = sink = None @@ -70,7 +74,9 @@ class Connection(Element): def get_enabled(self): """ Get the enabled state of this connection. - @return true if source and sink blocks are enabled + + Returns: + true if source and sink blocks are enabled """ return self.get_source().get_parent().get_enabled() and \ self.get_sink().get_parent().get_enabled() @@ -87,7 +93,9 @@ class Connection(Element): def export_data(self): """ Export this connection's info. - @return a nested data odict + + Returns: + a nested data odict """ n = odict() n['source_block_id'] = self.get_source().get_parent().get_id() |