From 3cfb3965bb25024a7b03870b71f02194e278919b Mon Sep 17 00:00:00 2001 From: Kelly Brazil Date: Tue, 25 Jan 2022 19:28:04 -0800 Subject: [PATCH] formatting --- docs/lib.md | 10 +++++----- docs/parsers/universal.md | 4 ++-- docs/utils.md | 24 ++++++++++++------------ 3 files changed, 19 insertions(+), 19 deletions(-) diff --git a/docs/lib.md b/docs/lib.md index ef1d9dcb..b386767e 100644 --- a/docs/lib.md +++ b/docs/lib.md @@ -7,7 +7,7 @@ JC lib module -#### parse +### parse ```python def parse(parser_mod_name: str, data: Union[str, Iterable[str]], quiet: Optional[bool] = False, raw: Optional[bool] = False, ignore_exceptions: Optional[Union[None, bool]] = None, **kwargs: Any, ,) -> Union[Dict[str, Any], @@ -73,7 +73,7 @@ Returns: -#### parser\_mod\_list +### parser\_mod\_list ```python def parser_mod_list() -> List[str] @@ -83,7 +83,7 @@ Returns a list of all available parser module names. -#### plugin\_parser\_mod\_list +### plugin\_parser\_mod\_list ```python def plugin_parser_mod_list() -> List[str] @@ -94,7 +94,7 @@ subset of `parser_mod_list()`. -#### parser\_info +### parser\_info ```python def parser_info(parser_mod_name: str) -> Dict[str, Any] @@ -107,7 +107,7 @@ variants of the module name string. -#### get\_help +### get\_help ```python def get_help(parser_mod_name: str) -> None diff --git a/docs/parsers/universal.md b/docs/parsers/universal.md index 96201ff8..799603ef 100644 --- a/docs/parsers/universal.md +++ b/docs/parsers/universal.md @@ -6,7 +6,7 @@ jc - JSON CLI output utility universal Parsers -#### simple\_table\_parse +### simple\_table\_parse ```python def simple_table_parse(data) @@ -31,7 +31,7 @@ Returns: -#### sparse\_table\_parse +### sparse\_table\_parse ```python def sparse_table_parse(data, delim='\u2063') diff --git a/docs/utils.md b/docs/utils.md index 642c794e..deed2f71 100644 --- a/docs/utils.md +++ b/docs/utils.md @@ -6,7 +6,7 @@ jc - JSON CLI output utility utils -#### warning\_message +### warning\_message ```python def warning_message(message_lines) @@ -26,7 +26,7 @@ Returns: -#### error\_message +### error\_message ```python def error_message(message_lines) @@ -46,7 +46,7 @@ Returns: -#### compatibility +### compatibility ```python def compatibility(mod_name, compatible, quiet=False) @@ -71,7 +71,7 @@ Returns: -#### has\_data +### has\_data ```python def has_data(data) @@ -91,7 +91,7 @@ Returns: -#### convert\_to\_int +### convert\_to\_int ```python def convert_to_int(value) @@ -110,7 +110,7 @@ Returns: -#### convert\_to\_float +### convert\_to\_float ```python def convert_to_float(value) @@ -129,7 +129,7 @@ Returns: -#### convert\_to\_bool +### convert\_to\_bool ```python def convert_to_bool(value) @@ -149,7 +149,7 @@ Returns: -#### stream\_success +### stream\_success ```python def stream_success(output_line, ignore_exceptions) @@ -159,7 +159,7 @@ Add `_jc_meta` object to output line if `ignore_exceptions=True` -#### stream\_error +### stream\_error ```python def stream_error(e, ignore_exceptions, line) @@ -170,7 +170,7 @@ Reraise the stream exception with annotation or print an error -#### input\_type\_check +### input\_type\_check ```python def input_type_check(data) @@ -180,7 +180,7 @@ Ensure input data is a string -#### streaming\_input\_type\_check +### streaming\_input\_type\_check ```python def streaming_input_type_check(data) @@ -190,7 +190,7 @@ Ensure input data is an iterable, but not a string or bytes -#### streaming\_line\_input\_type\_check +### streaming\_line\_input\_type\_check ```python def streaming_line_input_type_check(line)