python/jc
1
0
Fork 0
mirror of https://github.com/kellyjonbrazil/jc.git synced 2025-06-19 00:17:51 +02:00
Code Issues Releases Activity

doc update

Browse Source
This commit is contained in:
Kelly Brazil
2022-01-26 20:42:20 -08:00
parent 2adec2c003
commit ee98ab0a4a
2 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/lib.md
View File

@ -20,7 +20,7 @@ JC lib module
### parse ### parse
```python ```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. Parse the string data using the supplied parser module.
@ -105,7 +105,7 @@ subset of `parser_mod_list()`.
### parser\_info ### parser\_info
```python ```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. Returns a dictionary that includes the module metadata.
@ -118,7 +118,7 @@ This function will accept **module_name**, **cli-name**, and
### all\_parser\_info ### all\_parser\_info
```python ```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. Returns a list of dictionaris that includes metadata for all modules.

4
docs/utils.md
View File

@ -112,7 +112,7 @@ Returns:
### convert\_to\_int ### convert\_to\_int
```python ```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 Converts string and float input to int. Strips all non-numeric
@ -131,7 +131,7 @@ Returns:
### convert\_to\_float ### convert\_to\_float
```python ```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 Converts string and int input to float. Strips all non-numeric