From 7dac2f8dc3baf619105e3c6ca4d3e45300b86287 Mon Sep 17 00:00:00 2001 From: Kelly Brazil Date: Mon, 14 Mar 2022 10:50:10 -0700 Subject: [PATCH] doc update --- docs/lib.md | 23 +++++++++++++++++------ docs/readme.md | 7 +++++-- man/jc.1 | 2 +- 3 files changed, 23 insertions(+), 9 deletions(-) diff --git a/docs/lib.md b/docs/lib.md index ae714f9e..a74fbc52 100644 --- a/docs/lib.md +++ b/docs/lib.md @@ -133,23 +133,34 @@ subset of `parser_mod_list()`. ### parser\_info ```python -def parser_info(parser_mod_name: str) -> Dict +def parser_info(parser_mod_name: str, documentation: bool = False) -> Dict ``` -Returns a dictionary that includes the module metadata. +Returns a dictionary that includes the parser module metadata. -This function will accept **module_name**, **cli-name**, and -**--argument-name** variants of the module name string. +Parameters: + + parser_mod_name: (string) name of the parser module. This + function will accept module_name, + cli-name, and --argument-name + variants of the module name. + + documentation: (boolean) include parser docstring if True ### all\_parser\_info ```python -def all_parser_info() -> List[Dict] +def all_parser_info(documentation: bool = False) -> List[Dict] ``` -Returns a list of dictionaries that includes metadata for all modules. +Returns a list of dictionaries that includes metadata for all parser +modules. + +Parameters: + + documentation: (boolean) include parser docstrings if True diff --git a/docs/readme.md b/docs/readme.md index d224b4d7..9d2385ba 100644 --- a/docs/readme.md +++ b/docs/readme.md @@ -71,13 +71,16 @@ built-in parsers and local plugin parsers. ### parser_info - parser_info(parser_module_name: str) -> dict + parser_info( + parser_module_name: str, + documentation: bool = False + ) -> dict Get the metadata for a particular parser. ### all_parser_info - all_parser_info() -> list[dict] + all_parser_info(documentation: bool = False) -> list[dict] Get the metadata for all parsers. diff --git a/man/jc.1 b/man/jc.1 index 820be574..d88db55f 100644 --- a/man/jc.1 +++ b/man/jc.1 @@ -1,4 +1,4 @@ -.TH jc 1 2022-03-11 1.18.6 "JSON Convert" +.TH jc 1 2022-03-14 1.18.6 "JSON Convert" .SH NAME jc \- JSONifies the output of many CLI tools and file-types .SH SYNOPSIS