summaryrefslogtreecommitdiff
path: root/grc/grc_gnuradio/blks2/tcp.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/grc_gnuradio/blks2/tcp.py
parent3e46aef392ba9b2e63bbfefefdb7178cc87049ab (diff)
docs: Modified argument formating in python docstrings in grc.
Diffstat (limited to 'grc/grc_gnuradio/blks2/tcp.py')
-rw-r--r--grc/grc_gnuradio/blks2/tcp.py12
1 files changed, 8 insertions, 4 deletions
diff --git a/grc/grc_gnuradio/blks2/tcp.py b/grc/grc_gnuradio/blks2/tcp.py
index c6739b711e..dfebfcc2e6 100644
--- a/grc/grc_gnuradio/blks2/tcp.py
+++ b/grc/grc_gnuradio/blks2/tcp.py
@@ -28,10 +28,14 @@ def _get_sock_fd(addr, port, server):
Get the file descriptor for the socket.
As a client, block on connect, dup the socket descriptor.
As a server, block on accept, dup the client descriptor.
- @param addr the ip address string
- @param port the tcp port number
- @param server true for server mode, false for client mode
- @return the file descriptor number
+
+ Args:
+ addr: the ip address string
+ port: the tcp port number
+ server: true for server mode, false for client mode
+
+ Returns:
+ the file descriptor number
"""
sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
if server: