diff --git a/docs/lib.md b/docs/lib.md index 598f0a2b..8d2b7c2b 100644 --- a/docs/lib.md +++ b/docs/lib.md @@ -20,7 +20,7 @@ JC lib module ### parse ```python -def parse(parser_mod_name: str, data: Union[str, Iterable[str]], quiet: Optional[bool] = False, raw: Optional[bool] = False, ignore_exceptions: Optional[bool] = None, **kwargs: Optional[Any]) -> Union[Dict, List[Dict], Iterator[Dict]] +def parse(parser_mod_name: str, data: Union[str, Iterable[str]], quiet: bool = False, raw: bool = False, ignore_exceptions: bool = None, **kwargs) -> Union[Dict, List[Dict], Iterator[Dict]] ``` Parse the string data using the supplied parser module. @@ -105,7 +105,7 @@ subset of `parser_mod_list()`. ### parser\_info ```python -def parser_info(parser_mod_name: str) -> Dict +def parser_info(parser_mod_name: str) -> Union[Dict, None] ``` Returns a dictionary that includes the module metadata. @@ -118,7 +118,7 @@ This function will accept **module_name**, **cli-name**, and ### all\_parser\_info ```python -def all_parser_info() -> List[Dict] +def all_parser_info() -> List[Optional[Dict]] ``` Returns a list of dictionaris that includes metadata for all modules. diff --git a/docs/utils.md b/docs/utils.md index b0df4081..2b914cac 100644 --- a/docs/utils.md +++ b/docs/utils.md @@ -112,7 +112,7 @@ Returns: ### convert\_to\_int ```python -def convert_to_int(value: Union[str, float]) -> int +def convert_to_int(value: Union[str, float]) -> Union[int, None] ``` Converts string and float input to int. Strips all non-numeric @@ -131,7 +131,7 @@ Returns: ### convert\_to\_float ```python -def convert_to_float(value: Union[str, int]) -> float +def convert_to_float(value: Union[str, int]) -> Union[float, None] ``` Converts string and int input to float. Strips all non-numeric