doc fixes

jay-johnson · Apr 2, 2018 · 9d616b9 · 9d616b9
1 parent e2a64c7
commit 9d616b9
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 12 deletions.
diff --git a/docs/source/handle_packets.rst b/docs/source/handle_packets.rst
@@ -1,5 +1,5 @@
-Source Code - Handle Packets from a Network Interface
-=====================================================
+Handle Packets from a Network Interface
+=======================================
 
 This is the default handler for processing network packets received from the network interface with ``eth0`` or ``eth1``. In production, this is the starting point for making live predictions with the AntiNex REST API.
 

diff --git a/network_pipeline/scripts/listen_tcp_port.py b/network_pipeline/scripts/listen_tcp_port.py
@@ -12,11 +12,11 @@ def listen_on_tcp_port():
 
     Run a simple server for processing messages over ``TCP``.
 
-    LISTEN_ON_HOST
-    LISTEN_ON_PORT
-    LISTEN_SIZE
-    LISTEN_SLEEP
-    LISTEN_SHUTDOWN_HOOK
+    ``LISTEN_ON_HOST`` - listen on this host ip address
+    ``LISTEN_ON_PORT`` - listen on this ``TCP`` port
+    ``LISTEN_SIZE`` - listen on to packets of this size
+    ``LISTEN_SLEEP`` - sleep this number of seconds per loop
+    ``LISTEN_SHUTDOWN_HOOK`` - shutdown if file is found on disk
 
     """
 

diff --git a/network_pipeline/scripts/listen_udp_port.py b/network_pipeline/scripts/listen_udp_port.py
@@ -12,11 +12,11 @@ def listen_on_udp_port():
 
     Run a simple server for processing messages over ``UDP``.
 
-    UDP_LISTEN_ON_HOST
-    UDP_LISTEN_ON_PORT
-    UDP_LISTEN_SIZE
-    UDP_LISTEN_SLEEP
-    UDP_LISTEN_SHUTDOWN_HOOK
+    ``UDP_LISTEN_ON_HOST`` - listen on this host ip address
+    ``UDP_LISTEN_ON_PORT`` - listen on this ``UDP`` port
+    ``UDP_LISTEN_SIZE`` - listen on to packets of this size
+    ``UDP_LISTEN_SLEEP`` - sleep this number of seconds per loop
+    ``UDP_LISTEN_SHUTDOWN_HOOK`` - shutdown if file is found on disk
 
     """