python/jc
1
0
Fork 0
mirror of https://github.com/kellyjonbrazil/jc.git synced 2025-07-15 01:24:29 +02:00
Code Issues Releases Activity

doc update

Browse Source
This commit is contained in:
Kelly Brazil
2022-07-18 14:31:13 -07:00
parent 4f7f8dd82b
commit fe3b5bc2ed
4 changed files with 7 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/lib.md
View File

@ -22,7 +22,7 @@ jc - JSON Convert lib module
```python ```python
def parse(parser_mod_name: str, def parse(parser_mod_name: str,
data: Union[str, Iterable[str]], data: Union[str, bytes, Iterable[str]],
quiet: bool = False, quiet: bool = False,
raw: bool = False, raw: bool = False,
ignore_exceptions: bool = None, ignore_exceptions: bool = None,
@ -67,9 +67,9 @@ Parameters:
cli-name, and --argument-name cli-name, and --argument-name
variants of the module name. variants of the module name.
data: (string or data to parse (string for normal data: (string or data to parse (string or bytes for
iterable) parsers, iterable of strings for bytes or standard parsers, iterable of
streaming parsers) iterable) strings for streaming parsers)
raw: (boolean) output preprocessed JSON if True raw: (boolean) output preprocessed JSON if True

2
docs/readme.md
View File

@ -64,7 +64,7 @@ Use `help(jc.lib)` for details.
parse( parse(
parser_module_name: str, parser_module_name: str,
data: str | Iterable data: str | bytes | Iterable
) -> dict | list[dict] | Iterable[dict] ) -> dict | list[dict] | Iterable[dict]
High-level API to easily access the parser. This API will find both High-level API to easily access the parser. This API will find both

2
jc/__init__.py
View File

@ -60,7 +60,7 @@ Use `help(jc.lib)` for details.
parse( parse(
parser_module_name: str, parser_module_name: str,
data: str | Iterable data: str | bytes | Iterable
) -> dict | list[dict] | Iterable[dict] ) -> dict | list[dict] | Iterable[dict]
High-level API to easily access the parser. This API will find both High-level API to easily access the parser. This API will find both

2
man/jc.1
View File

@ -1,4 +1,4 @@
.TH jc 1 2022-07-16 1.20.3 "JSON Convert" .TH jc 1 2022-07-18 1.20.3 "JSON Convert"
.SH NAME .SH NAME
\fBjc\fP \- JSON Convert JSONifies the output of many CLI tools and file-types \fBjc\fP \- JSON Convert JSONifies the output of many CLI tools and file-types
.SH SYNOPSIS .SH SYNOPSIS