diff --git a/docs/lib.md b/docs/lib.md index 220859f4..702c3087 100644 --- a/docs/lib.md +++ b/docs/lib.md @@ -21,12 +21,14 @@ jc - JSON Convert lib module ### parse ```python -def parse(parser_mod_name: Union[str, ModuleType], - data: Union[str, bytes, Iterable[str]], - quiet: bool = False, - raw: bool = False, - ignore_exceptions: bool = None, - **kwargs) -> Union[Dict, List[Dict], Iterator[Dict]] +def parse( + parser_mod_name: Union[str, ModuleType], + data: Union[str, bytes, Iterable[str]], + quiet: bool = False, + raw: bool = False, + ignore_exceptions: bool = None, + **kwargs +) -> Union[JSONDictType, List[JSONDictType], Iterator[JSONDictType]] ``` Parse the string or bytes data using the supplied parser module. @@ -158,7 +160,8 @@ subset of `parser_mod_list()`. ### parser\_info ```python -def parser_info(parser_mod_name: str, documentation: bool = False) -> Dict +def parser_info(parser_mod_name: str, + documentation: bool = False) -> JSONDictType ``` Returns a dictionary that includes the parser module metadata. @@ -179,7 +182,7 @@ Parameters: ```python def all_parser_info(documentation: bool = False, show_hidden: bool = False, - show_deprecated: bool = False) -> List[Dict] + show_deprecated: bool = False) -> List[JSONDictType] ``` Returns a list of dictionaries that includes metadata for all parser diff --git a/docs/utils.md b/docs/utils.md index 0004f63f..87bd7511 100644 --- a/docs/utils.md +++ b/docs/utils.md @@ -64,7 +64,7 @@ Returns: ### is\_compatible ```python -def is_compatible(compatible: List) -> bool +def is_compatible(compatible: List[str]) -> bool ``` Returns True if the parser is compatible with the running OS platform. @@ -75,7 +75,7 @@ Returns True if the parser is compatible with the running OS platform. ```python def compatibility(mod_name: str, - compatible: List, + compatible: List[str], quiet: bool = False) -> None ``` @@ -202,7 +202,7 @@ class timestamp() ```python def __init__(datetime_string: str, - format_hint: Optional[Iterable] = None) -> None + format_hint: Optional[Iterable[int]] = None) -> None ``` Input a datetime text string of several formats and convert to a diff --git a/man/jc.1 b/man/jc.1 index 3d574315..1c6b8c0d 100644 --- a/man/jc.1 +++ b/man/jc.1 @@ -1,4 +1,4 @@ -.TH jc 1 2022-10-14 1.22.1 "JSON Convert" +.TH jc 1 2022-10-15 1.22.1 "JSON Convert" .SH NAME \fBjc\fP \- JSON Convert JSONifies the output of many CLI tools, file-types, and strings .SH SYNOPSIS