From fe3b5bc2ed2ad63ab207912ca99f059779bd5b52 Mon Sep 17 00:00:00 2001 From: Kelly Brazil Date: Mon, 18 Jul 2022 14:31:13 -0700 Subject: [PATCH] doc update --- docs/lib.md | 8 ++++---- docs/readme.md | 2 +- jc/__init__.py | 2 +- man/jc.1 | 2 +- 4 files changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/lib.md b/docs/lib.md index c346baec..73c50f46 100644 --- a/docs/lib.md +++ b/docs/lib.md @@ -22,7 +22,7 @@ jc - JSON Convert lib module ```python def parse(parser_mod_name: str, - data: Union[str, Iterable[str]], + data: Union[str, bytes, Iterable[str]], quiet: bool = False, raw: bool = False, ignore_exceptions: bool = None, @@ -67,9 +67,9 @@ Parameters: cli-name, and --argument-name variants of the module name. - data: (string or data to parse (string for normal - iterable) parsers, iterable of strings for - streaming parsers) + data: (string or data to parse (string or bytes for + bytes or standard parsers, iterable of + iterable) strings for streaming parsers) raw: (boolean) output preprocessed JSON if True diff --git a/docs/readme.md b/docs/readme.md index 2335ca66..c87a0766 100644 --- a/docs/readme.md +++ b/docs/readme.md @@ -64,7 +64,7 @@ Use `help(jc.lib)` for details. parse( parser_module_name: str, - data: str | Iterable + data: str | bytes | Iterable ) -> dict | list[dict] | Iterable[dict] High-level API to easily access the parser. This API will find both diff --git a/jc/__init__.py b/jc/__init__.py index 9f7522e8..bbf8ab97 100644 --- a/jc/__init__.py +++ b/jc/__init__.py @@ -60,7 +60,7 @@ Use `help(jc.lib)` for details. parse( parser_module_name: str, - data: str | Iterable + data: str | bytes | Iterable ) -> dict | list[dict] | Iterable[dict] High-level API to easily access the parser. This API will find both diff --git a/man/jc.1 b/man/jc.1 index 2aaf8438..7b7cb5b4 100644 --- a/man/jc.1 +++ b/man/jc.1 @@ -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 \fBjc\fP \- JSON Convert JSONifies the output of many CLI tools and file-types .SH SYNOPSIS