update docs

docs/parsers/ls_s.md

@@ -69,7 +69,7 @@ Provides parser metadata (version, author, etc.)
 parse(data, raw=False, quiet=False)
 ```
 
-Main text parsing generator function. Produces an iterable object.
+Main text parsing generator function. Returns an iterator object.
 
 Parameters:
 
@@ -81,6 +81,10 @@ Yields:
 
     Dictionary. Raw or processed structured data.
 
+Returns:
+
+    Iterator object
+
 ## Parser Information
 Compatibility:  linux, darwin, cygwin, aix, freebsd
 

docs/parsers/ping_s.md

@@ -76,7 +76,7 @@ Provides parser metadata (version, author, etc.)
 parse(data, raw=False, quiet=False)
 ```
 
-Main text parsing generator function. Produces an iterable object.
+Main text parsing generator function. Returns an iterator object.
 
 Parameters:
 
@@ -88,6 +88,10 @@ Yields:
 
     Dictionary. Raw or processed structured data.
 
+Returns:
+
+    Iterator object
+
 ## Parser Information
 Compatibility:  linux, darwin, freebsd
 

jc/parsers/foo_s.py

@@ -75,7 +75,7 @@ def _process(proc_data):
 
 def parse(data, raw=False, quiet=False):
     """
-    Main text parsing generator function. Produces an iterable object.
+    Main text parsing generator function. Returns an iterator object.
 
     Parameters:
 
@@ -86,6 +86,10 @@ def parse(data, raw=False, quiet=False):
     Yields:
 
         Dictionary. Raw or processed structured data.
+
+    Returns:
+
+        Iterator object
     """
     if not quiet:
         jc.utils.compatibility(__name__, info.compatible)

jc/parsers/ls_s.py

@@ -104,7 +104,7 @@ def _process(proc_data):
 
 def parse(data, raw=False, quiet=False):
     """
-    Main text parsing generator function. Produces an iterable object.
+    Main text parsing generator function. Returns an iterator object.
 
     Parameters:
 
@@ -115,6 +115,10 @@ def parse(data, raw=False, quiet=False):
     Yields:
 
         Dictionary. Raw or processed structured data.
+
+    Returns:
+
+        Iterator object
     """
     if not quiet:
         jc.utils.compatibility(__name__, info.compatible)

jc/parsers/ping_s.py

@@ -451,7 +451,7 @@ def _linux_parse(line, s):
 
 def parse(data, raw=False, quiet=False):
     """
-    Main text parsing generator function. Produces an iterable object.
+    Main text parsing generator function. Returns an iterator object.
 
     Parameters:
 
@@ -462,6 +462,10 @@ def parse(data, raw=False, quiet=False):
     Yields:
 
         Dictionary. Raw or processed structured data.
+
+    Returns:
+
+        Iterator object
     """
     s = _state()