From 6be3d3d98222a262c5138bb09f2951ccfab96110 Mon Sep 17 00:00:00 2001 From: Kelly Brazil Date: Thu, 3 Mar 2022 17:38:47 -0800 Subject: [PATCH] doc update --- CHANGELOG | 3 ++- docs/lib.md | 25 +++++++++++++++++++++++++ docs/readme.md | 16 ++++++++++++++++ 3 files changed, 43 insertions(+), 1 deletion(-) diff --git a/CHANGELOG b/CHANGELOG index 229b55df..a3b291e9 100644 --- a/CHANGELOG +++ b/CHANGELOG @@ -1,8 +1,9 @@ jc changelog -20220224 v1.18.4 +20220303 v1.18.4 - Add nmcli command parser tested on linux - Enhance parse error messages at the cli +- Add standard and streaming parser list functions to the public API 20220214 v1.18.3 - Add rsync command and log file parser tested on linux and macOS diff --git a/docs/lib.md b/docs/lib.md index 6b79fe1d..e3fad7fa 100644 --- a/docs/lib.md +++ b/docs/lib.md @@ -4,6 +4,8 @@ * [parse](#jc.lib.parse) * [parser\_mod\_list](#jc.lib.parser_mod_list) * [plugin\_parser\_mod\_list](#jc.lib.plugin_parser_mod_list) + * [standard\_parser\_mod\_list](#jc.lib.standard_parser_mod_list) + * [streaming\_parser\_mod\_list](#jc.lib.streaming_parser_mod_list) * [parser\_info](#jc.lib.parser_info) * [all\_parser\_info](#jc.lib.all_parser_info) * [get\_help](#jc.lib.get_help) @@ -100,6 +102,29 @@ def plugin_parser_mod_list() -> List[str] Returns a list of plugin parser module names. This function is a subset of `parser_mod_list()`. + + +### standard\_parser\_mod\_list + +```python +def standard_parser_mod_list() -> List[str] +``` + +Returns a list of standard parser module names. This function is a +subset of `parser_mod_list()` and does not contain any streaming +parsers. + + + +### streaming\_parser\_mod\_list + +```python +def streaming_parser_mod_list() -> List[str] +``` + +Returns a list of streaming parser module names. This function is a +subset of `parser_mod_list()`. + ### parser\_info diff --git a/docs/readme.md b/docs/readme.md index c5387f75..e5c3d8ec 100644 --- a/docs/readme.md +++ b/docs/readme.md @@ -103,3 +103,19 @@ Get a list of plugin parser module names to be used in `parse()`, `parser_info()`, and `get_help()`. This list is a subset of `parser_mod_list()`. +### standard_parser_mod_list + + standard_parser_mod_list() -> list + +Get a list of standard parser module names to be used in +`parse()`, `parser_info()`, and `get_help()`. This list is a subset of +`parser_mod_list()` and does not contain any streaming parsers. + +### streaming_parser_mod_list + + streaming_parser_mod_list() -> list + +Get a list of streaming parser module names to be used in +`parse()`, `parser_info()`, and `get_help()`. This list is a subset of +`parser_mod_list()`. +