1
0
mirror of https://github.com/kellyjonbrazil/jc.git synced 2026-06-19 22:28:17 +02:00

update docs

This commit is contained in:
Kelly Brazil
2021-09-21 16:03:00 -07:00
parent 1baec0b420
commit b5fa6d068f
5 changed files with 25 additions and 5 deletions
+5 -1
View File
@@ -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
+5 -1
View File
@@ -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