Skip to content

Commit

Permalink
Docstrings for Observer constructor
Browse files Browse the repository at this point in the history
  • Loading branch information
Iain R. Learmonth committed Jul 1, 2016
1 parent 181315f commit 750d3f0
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 1 deletion.
3 changes: 2 additions & 1 deletion doc/observer.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,5 @@ Observer Implementation

.. autoclass:: pathspider.observer.Observer
:members:

:undoc-members:
:special-members: __init__
17 changes: 17 additions & 0 deletions pathspider/observer.py
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,23 @@ def __init__(self, lturi,
tcp_chain=[],
udp_chain=[],
l4_chain=[]):
"""
Create an Observer.
:param new_flow_chain: Array of functions to initialise new flows.
:type new_flow_chain: array(function)
:param ip4_chain: Array of functions to pass IPv4 headers to.
:type ip4_chain: array(function)
:param ip6_chain: Array of functions to pass IPv6 headers to.
:type ip6_chain: array(function)
:param tcp_chain: Array of functions to pass TCP headers to.
:type tcp_chain: array(function)
:param udp_chain: Array of functions to pass UDP headers to.
:type udp_chain: array(function)
:param l4_chain: Array of functions to pass other layer 4 headers to.
:type l4_chain: array(function)
:see also: :ref:`Observer Documentation <observer>`
"""

# Only import this when needed
import plt as libtrace
Expand Down

0 comments on commit 750d3f0

Please sign in to comment.