mirror of
https://github.com/kellyjonbrazil/jc.git
synced 2025-08-08 22:36:48 +02:00
doc update
This commit is contained in:
23
docs/lib.md
23
docs/lib.md
@ -133,23 +133,34 @@ 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, 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
|
Parameters:
|
||||||
**--argument-name** variants of the module name string.
|
|
||||||
|
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
|
||||||
|
|
||||||
<a id="jc.lib.all_parser_info"></a>
|
<a id="jc.lib.all_parser_info"></a>
|
||||||
|
|
||||||
### all\_parser\_info
|
### all\_parser\_info
|
||||||
|
|
||||||
```python
|
```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
|
||||||
|
|
||||||
<a id="jc.lib.get_help"></a>
|
<a id="jc.lib.get_help"></a>
|
||||||
|
|
||||||
|
@ -71,13 +71,16 @@ built-in parsers and local plugin parsers.
|
|||||||
|
|
||||||
### parser_info
|
### 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.
|
Get the metadata for a particular parser.
|
||||||
|
|
||||||
### all_parser_info
|
### all_parser_info
|
||||||
|
|
||||||
all_parser_info() -> list[dict]
|
all_parser_info(documentation: bool = False) -> list[dict]
|
||||||
|
|
||||||
Get the metadata for all parsers.
|
Get the metadata for all parsers.
|
||||||
|
|
||||||
|
Reference in New Issue
Block a user