python/jc
1
0
Fork 0
mirror of https://github.com/kellyjonbrazil/jc.git synced 2025-07-13 01:20:24 +02:00
Code Issues Releases Activity

doc update

Browse Source
This commit is contained in:
Kelly Brazil
2022-05-09 16:09:40 -07:00
parent 86c279cbb2
commit 9bc02a5623
1 changed files with 8 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
jc/__init__.py
View File

@ -22,11 +22,12 @@ https://github.com/kellyjonbrazil/jc/tree/master/docs
### Specific Version ### Specific Version
Replace `<full_version_number>` - e.g. `1.17.7`:
`https://github.com/kellyjonbrazil/jc/tree/v<full_version_number>/docs` `https://github.com/kellyjonbrazil/jc/tree/v<full_version_number>/docs`
Specific versions can also be selected by tag in the branch dropdown menu. > Replace `<full_version_number>` - e.g. `1.18.0`:
Specific versions can also be selected by tag in the branch Github dropdown
menu.
## Usage Example ## Usage Example
@ -89,14 +90,14 @@ its module name.
### parser_mod_list ### parser_mod_list
parser_mod_list() -> list parser_mod_list() -> list[str]
Get a list of all available parser module names to be used in Get a list of all available parser module names to be used in
`parse()`, `parser_info()`, and `get_help()`. `parse()`, `parser_info()`, and `get_help()`.
### plugin_parser_mod_list ### plugin_parser_mod_list
plugin_parser_mod_list() -> list plugin_parser_mod_list() -> list[str]
Get a list of plugin parser module names to be used in Get a list of plugin parser module names to be used in
`parse()`, `parser_info()`, and `get_help()`. This list is a subset of `parse()`, `parser_info()`, and `get_help()`. This list is a subset of
@ -104,7 +105,7 @@ Get a list of plugin parser module names to be used in
### standard_parser_mod_list ### standard_parser_mod_list
standard_parser_mod_list() -> list standard_parser_mod_list() -> list[str]
Get a list of standard parser module names to be used in Get a list of standard parser module names to be used in
`parse()`, `parser_info()`, and `get_help()`. This list is a subset of `parse()`, `parser_info()`, and `get_help()`. This list is a subset of
@ -112,7 +113,7 @@ Get a list of standard parser module names to be used in
### streaming_parser_mod_list ### streaming_parser_mod_list
streaming_parser_mod_list() -> list streaming_parser_mod_list() -> list[str]
Get a list of streaming parser module names to be used in Get a list of streaming parser module names to be used in
`parse()`, `parser_info()`, and `get_help()`. This list is a subset of `parse()`, `parser_info()`, and `get_help()`. This list is a subset of