1
0
mirror of https://github.com/kellyjonbrazil/jc.git synced 2025-07-13 01:20:24 +02:00

doc update

This commit is contained in:
Kelly Brazil
2022-03-24 16:58:45 -07:00
parent 304ae6268f
commit 38de059a1b
3 changed files with 9 additions and 3 deletions

View File

@ -43,6 +43,12 @@ For example:
good day 12345 good day 12345
hi there abc def 3.14 hi there abc def 3.14
or
foo bar baz
good day 12345
hi there abc def 3.14
etc... etc...
Headers (keys) are converted to snake-case. All values are returned as Headers (keys) are converted to snake-case. All values are returned as

View File

@ -15,7 +15,7 @@ jc - JSON Convert universal parsers
### simple\_table\_parse ### simple\_table\_parse
```python ```python
def simple_table_parse(data: List[str]) -> List[Dict] def simple_table_parse(data: Iterable[str]) -> List[Dict]
``` ```
Parse simple tables. There should be no blank cells. The last column Parse simple tables. There should be no blank cells. The last column
@ -36,7 +36,7 @@ Example Table:
Parameters: Parameters:
data: (list) Text data to parse that has been split into lines data: (iter) Text data to parse that has been split into lines
via .splitlines(). Item 0 must be the header row. via .splitlines(). Item 0 must be the header row.
Any spaces in header names should be changed to Any spaces in header names should be changed to
underscore '_'. You should also ensure headers are underscore '_'. You should also ensure headers are

View File

@ -1,4 +1,4 @@
.TH jc 1 2022-03-23 1.18.6 "JSON Convert" .TH jc 1 2022-03-24 1.18.6 "JSON Convert"
.SH NAME .SH NAME
jc \- JSONifies the output of many CLI tools and file-types jc \- JSONifies the output of many CLI tools and file-types
.SH SYNOPSIS .SH SYNOPSIS