From 38de059a1bc285c8681086d9fb43d0d23ac01d49 Mon Sep 17 00:00:00 2001 From: Kelly Brazil Date: Thu, 24 Mar 2022 16:58:45 -0700 Subject: [PATCH] doc update --- docs/parsers/asciitable.md | 6 ++++++ docs/parsers/universal.md | 4 ++-- man/jc.1 | 2 +- 3 files changed, 9 insertions(+), 3 deletions(-) diff --git a/docs/parsers/asciitable.md b/docs/parsers/asciitable.md index de06fcc0..7fd59e0c 100644 --- a/docs/parsers/asciitable.md +++ b/docs/parsers/asciitable.md @@ -43,6 +43,12 @@ For example: good day 12345 hi there abc def 3.14 + or + + foo bar baz + good day 12345 + hi there abc def 3.14 + etc... Headers (keys) are converted to snake-case. All values are returned as diff --git a/docs/parsers/universal.md b/docs/parsers/universal.md index 40889af5..da8eddd0 100644 --- a/docs/parsers/universal.md +++ b/docs/parsers/universal.md @@ -15,7 +15,7 @@ jc - JSON Convert universal parsers ### simple\_table\_parse ```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 @@ -36,7 +36,7 @@ Example Table: 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. Any spaces in header names should be changed to underscore '_'. You should also ensure headers are diff --git a/man/jc.1 b/man/jc.1 index 3d16284f..bb90e889 100644 --- a/man/jc.1 +++ b/man/jc.1 @@ -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 jc \- JSONifies the output of many CLI tools and file-types .SH SYNOPSIS