doc update

jc/parsers/arp.py

@@ -106,7 +106,7 @@ def process(proc_data):
 
 def parse(data, raw=False, quiet=False):
     """
-    Main parsing function
+    Main text parsing function
 
     Parameters:
         

jc/parsers/df.py

@@ -111,12 +111,17 @@ def process(proc_data):
 
 def parse(data, raw=False, quiet=False):
     """
-    Main parsing function
+    Main text parsing function
 
-    Arguments:
+    Parameters:
         
+        data:        (string)  text data to parse
         raw:         (boolean) output preprocessed JSON if True
         quiet:       (boolean) suppress warning messages if True
+
+    Returns:
+
+        dictionary   raw or processed structured data
     """
     
     # compatible options: linux, darwin, cygwin, win32, aix, freebsd

jc/parsers/dig.py

@@ -483,12 +483,17 @@ def parse_answer(answer):
 
 def parse(data, raw=False, quiet=False):
     """
-    Main parsing function
+    Main text parsing function
 
-    Arguments:
+    Parameters:
         
+        data:        (string)  text data to parse
         raw:         (boolean) output preprocessed JSON if True
         quiet:       (boolean) suppress warning messages if True
+
+    Returns:
+
+        dictionary   raw or processed structured data
     """
     
     # compatible options: linux, darwin, cygwin, win32, aix, freebsd

jc/parsers/env.py

@@ -71,12 +71,17 @@ def process(proc_data):
 
 def parse(data, raw=False, quiet=False):
     """
-    Main parsing function
+    Main text parsing function
 
-    Arguments:
+    Parameters:
         
+        data:        (string)  text data to parse
         raw:         (boolean) output preprocessed JSON if True
         quiet:       (boolean) suppress warning messages if True
+
+    Returns:
+
+        dictionary   raw or processed structured data
     """
     
     # compatible options: linux, darwin, cygwin, win32, aix, freebsd

jc/parsers/foo.py

@@ -33,12 +33,17 @@ def process(proc_data):
 
 def parse(data, raw=False, quiet=False):
     """
-    Main parsing function
+    Main text parsing function
 
-    Arguments:
+    Parameters:
         
+        data:        (string)  text data to parse
         raw:         (boolean) output preprocessed JSON if True
         quiet:       (boolean) suppress warning messages if True
+
+    Returns:
+
+        dictionary   raw or processed structured data
     """
     
     # compatible options: linux, darwin, cygwin, win32, aix, freebsd

jc/parsers/free.py

@@ -78,12 +78,17 @@ def process(proc_data):
 
 def parse(data, raw=False, quiet=False):
     """
-    Main parsing function
+    Main text parsing function
 
-    Arguments:
+    Parameters:
         
+        data:        (string)  text data to parse
         raw:         (boolean) output preprocessed JSON if True
         quiet:       (boolean) suppress warning messages if True
+
+    Returns:
+
+        dictionary   raw or processed structured data
     """
     
     # compatible options: linux, darwin, cygwin, win32, aix, freebsd

jc/parsers/history.py

@@ -63,12 +63,17 @@ def process(proc_data):
 
 def parse(data, raw=False, quiet=False):
     """
-    Main parsing function
+    Main text parsing function
 
-    Arguments:
+    Parameters:
         
+        data:        (string)  text data to parse
         raw:         (boolean) output preprocessed JSON if True
         quiet:       (boolean) suppress warning messages if True
+
+    Returns:
+
+        dictionary   raw or processed structured data
     """
     
     # compatible options: linux, darwin, cygwin, win32, aix, freebsd

jc/parsers/ifconfig.py

@@ -173,12 +173,17 @@ def process(proc_data):
 
 def parse(data, raw=False, quiet=False):
     """
-    Main parsing function
+    Main text parsing function
 
-    Arguments:
+    Parameters:
         
+        data:        (string)  text data to parse
         raw:         (boolean) output preprocessed JSON if True
         quiet:       (boolean) suppress warning messages if True
+
+    Returns:
+
+        dictionary   raw or processed structured data
     """
     
     # compatible options: linux, darwin, cygwin, win32, aix, freebsd

jc/parsers/iptables.py

@@ -197,12 +197,17 @@ def process(proc_data):
 
 def parse(data, raw=False, quiet=False):
     """
-    Main parsing function
+    Main text parsing function
 
-    Arguments:
+    Parameters:
         
+        data:        (string)  text data to parse
         raw:         (boolean) output preprocessed JSON if True
         quiet:       (boolean) suppress warning messages if True
+
+    Returns:
+
+        dictionary   raw or processed structured data
     """
     
     # compatible options: linux, darwin, cygwin, win32, aix, freebsd

jc/parsers/jobs.py

@@ -99,12 +99,17 @@ def process(proc_data):
 
 def parse(data, raw=False, quiet=False):
     """
-    Main parsing function
+    Main text parsing function
 
-    Arguments:
+    Parameters:
         
+        data:        (string)  text data to parse
         raw:         (boolean) output preprocessed JSON if True
         quiet:       (boolean) suppress warning messages if True
+
+    Returns:
+
+        dictionary   raw or processed structured data
     """
     
     # compatible options: linux, darwin, cygwin, win32, aix, freebsd

jc/parsers/ls.py

@@ -170,12 +170,17 @@ def process(proc_data):
 
 def parse(data, raw=False, quiet=False):
     """
-    Main parsing function
+    Main text parsing function
 
-    Arguments:
+    Parameters:
         
+        data:        (string)  text data to parse
         raw:         (boolean) output preprocessed JSON if True
         quiet:       (boolean) suppress warning messages if True
+
+    Returns:
+
+        dictionary   raw or processed structured data
     """
     
     # compatible options: linux, darwin, cygwin, win32, aix, freebsd

jc/parsers/lsblk.py

@@ -285,12 +285,17 @@ def process(proc_data):
 
 def parse(data, raw=False, quiet=False):
     """
-    Main parsing function
+    Main text parsing function
 
-    Arguments:
+    Parameters:
         
+        data:        (string)  text data to parse
         raw:         (boolean) output preprocessed JSON if True
         quiet:       (boolean) suppress warning messages if True
+
+    Returns:
+
+        dictionary   raw or processed structured data
     """
     
     # compatible options: linux, darwin, cygwin, win32, aix, freebsd

jc/parsers/lsmod.py

@@ -131,12 +131,17 @@ def process(proc_data):
 
 def parse(data, raw=False, quiet=False):
     """
-    Main parsing function
+    Main text parsing function
 
-    Arguments:
+    Parameters:
         
+        data:        (string)  text data to parse
         raw:         (boolean) output preprocessed JSON if True
         quiet:       (boolean) suppress warning messages if True
+
+    Returns:
+
+        dictionary   raw or processed structured data
     """
     
     # compatible options: linux, darwin, cygwin, win32, aix, freebsd

jc/parsers/lsof.py

@@ -125,12 +125,17 @@ def process(proc_data):
 
 def parse(data, raw=False, quiet=False):
     """
-    Main parsing function
+    Main text parsing function
 
-    Arguments:
+    Parameters:
         
+        data:        (string)  text data to parse
         raw:         (boolean) output preprocessed JSON if True
         quiet:       (boolean) suppress warning messages if True
+
+    Returns:
+
+        dictionary   raw or processed structured data
     """
     
     # compatible options: linux, darwin, cygwin, win32, aix, freebsd

jc/parsers/mount.py

@@ -71,12 +71,17 @@ def process(proc_data):
 
 def parse(data, raw=False, quiet=False):
     """
-    Main parsing function
+    Main text parsing function
 
-    Arguments:
+    Parameters:
         
+        data:        (string)  text data to parse
         raw:         (boolean) output preprocessed JSON if True
         quiet:       (boolean) suppress warning messages if True
+
+    Returns:
+
+        dictionary   raw or processed structured data
     """
     
     # compatible options: linux, darwin, cygwin, win32, aix, freebsd

jc/parsers/netstat.py

@@ -488,12 +488,17 @@ def parse_post(raw_data):
 
 def parse(data, raw=False, quiet=False):
     """
-    Main parsing function
+    Main text parsing function
 
-    Arguments:
+    Parameters:
         
+        data:        (string)  text data to parse
         raw:         (boolean) output preprocessed JSON if True
         quiet:       (boolean) suppress warning messages if True
+
+    Returns:
+
+        dictionary   raw or processed structured data
     """
     
     # compatible options: linux, darwin, cygwin, win32, aix, freebsd

jc/parsers/ps.py

@@ -238,12 +238,17 @@ def process(proc_data):
 
 def parse(data, raw=False, quiet=False):
     """
-    Main parsing function
+    Main text parsing function
 
-    Arguments:
+    Parameters:
         
+        data:        (string)  text data to parse
         raw:         (boolean) output preprocessed JSON if True
         quiet:       (boolean) suppress warning messages if True
+
+    Returns:
+
+        dictionary   raw or processed structured data
     """
     
     # compatible options: linux, darwin, cygwin, win32, aix, freebsd

jc/parsers/route.py

@@ -129,12 +129,17 @@ def process(proc_data):
 
 def parse(data, raw=False, quiet=False):
     """
-    Main parsing function
+    Main text parsing function
 
-    Arguments:
+    Parameters:
         
+        data:        (string)  text data to parse
         raw:         (boolean) output preprocessed JSON if True
         quiet:       (boolean) suppress warning messages if True
+
+    Returns:
+
+        dictionary   raw or processed structured data
     """
     
     # compatible options: linux, darwin, cygwin, win32, aix, freebsd

jc/parsers/uname.py

@@ -44,12 +44,17 @@ def process(proc_data):
 
 def parse(data, raw=False, quiet=False):
     """
-    Main parsing function
+    Main text parsing function
 
-    Arguments:
+    Parameters:
         
+        data:        (string)  text data to parse
         raw:         (boolean) output preprocessed JSON if True
         quiet:       (boolean) suppress warning messages if True
+
+    Returns:
+
+        dictionary   raw or processed structured data
     """
     
     # compatible options: linux, darwin, cygwin, win32, aix, freebsd

jc/parsers/uptime.py

@@ -64,12 +64,17 @@ def process(proc_data):
 
 def parse(data, raw=False, quiet=False):
     """
-    Main parsing function
+    Main text parsing function
 
-    Arguments:
+    Parameters:
         
+        data:        (string)  text data to parse
         raw:         (boolean) output preprocessed JSON if True
         quiet:       (boolean) suppress warning messages if True
+
+    Returns:
+
+        dictionary   raw or processed structured data
     """
     
     # compatible options: linux, darwin, cygwin, win32, aix, freebsd

jc/parsers/w.py

@@ -106,12 +106,17 @@ def process(proc_data):
 
 def parse(data, raw=False, quiet=False):
     """
-    Main parsing function
+    Main text parsing function
 
-    Arguments:
+    Parameters:
         
+        data:        (string)  text data to parse
         raw:         (boolean) output preprocessed JSON if True
         quiet:       (boolean) suppress warning messages if True
+
+    Returns:
+
+        dictionary   raw or processed structured data
     """
     
     # compatible options: linux, darwin, cygwin, win32, aix, freebsd