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/Port.py | |
| parent | 3e46aef392ba9b2e63bbfefefdb7178cc87049ab (diff) | |
docs: Modified argument formating in python docstrings in grc.
Diffstat (limited to 'grc/base/Port.py')
| -rw-r--r-- | grc/base/Port.py | 16 |
1 files changed, 11 insertions, 5 deletions
diff --git a/grc/base/Port.py b/grc/base/Port.py index 7a1b5d4e69..0e58f583c3 100644 --- a/grc/base/Port.py +++ b/grc/base/Port.py @@ -24,9 +24,11 @@ class Port(Element): def __init__(self, block, n, dir): """ Make a new port from nested data. - @param block the parent element - @param n the nested odict - @param dir the direction source or sink + + Args: + block: the parent element + n: the nested odict + dir: the direction source or sink """ #build the port Element.__init__(self, block) @@ -69,7 +71,9 @@ class Port(Element): def get_connections(self): """ Get all connections that use this port. - @return a list of connection objects + + Returns: + a list of connection objects """ connections = self.get_parent().get_parent().get_connections() connections = filter(lambda c: c.get_source() is self or c.get_sink() is self, connections) @@ -78,6 +82,8 @@ class Port(Element): def get_enabled_connections(self): """ Get all enabled connections that use this port. - @return a list of connection objects + + Returns: + a list of connection objects """ return filter(lambda c: c.get_enabled(), self.get_connections()) |