From dd70bf92f3395fdb0283645b65d47962bbe917cc Mon Sep 17 00:00:00 2001 From: Kelly Brazil Date: Sat, 15 Oct 2022 14:43:45 -0700 Subject: [PATCH] doc update --- docs/lib.md | 3 ++- jc/lib.py | 3 ++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/lib.md b/docs/lib.md index 702c3087..4c36b0c5 100644 --- a/docs/lib.md +++ b/docs/lib.md @@ -31,7 +31,8 @@ def parse( ) -> Union[JSONDictType, List[JSONDictType], Iterator[JSONDictType]] ``` -Parse the string or bytes data using the supplied parser module. +Parse the data (string or bytes) using the supplied parser (string or +module object). This function provides a high-level API to simplify parser use. This function will call built-in parsers and custom plugin parsers. diff --git a/jc/lib.py b/jc/lib.py index 605cf2b7..b4f9d579 100644 --- a/jc/lib.py +++ b/jc/lib.py @@ -270,7 +270,8 @@ def parse( **kwargs ) -> Union[JSONDictType, List[JSONDictType], Iterator[JSONDictType]]: """ - Parse the string or bytes data using the supplied parser module. + Parse the data (string or bytes) using the supplied parser (string or + module object). This function provides a high-level API to simplify parser use. This function will call built-in parsers and custom plugin parsers.