python/jc
1
0
Fork 0
mirror of https://github.com/kellyjonbrazil/jc.git synced 2025-06-19 00:17:51 +02:00
Code Issues Releases Activity

formatting

Browse Source
This commit is contained in:
Kelly Brazil
2022-01-19 19:22:08 -08:00
parent 299a9c6d88
commit 66b2c28f4b
2 changed files with 24 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
docs/readme.md
View File

@ -38,19 +38,19 @@ Available Functions:
* Use `help(jc.lib)` for details
parse(parser_module_name: str, data: str | iterable)
High-level API to easily access the parser. This API will find both
built-in parsers and local plugin parsers.
parse(parser_module_name: str, data: str | iterable)
High-level API to easily access the parser. This API will find both
built-in parsers and local plugin parsers.
get_help(parser_module_name: str)
Convenience function to display the help screen for a parser using its
module name.
get_help(parser_module_name: str)
Convenience function to display the help screen for a parser using its
module name.
parser_mod_list()
Get a list of all available parser module names to be used in parse()
and get_help().
parser_mod_list()
Get a list of all available parser module names to be used in parse()
and get_help().
plugin_parser_mod_list()
Get a list of plugin parser module names. This list is a subset of
parser_mod_list().
plugin_parser_mod_list()
Get a list of plugin parser module names. This list is a subset of
parser_mod_list().

24
jc/__init__.py
View File

@ -36,21 +36,21 @@ Available Functions:
* Use `help(jc.lib)` for details
parse(parser_module_name: str, data: str | iterable)
High-level API to easily access the parser. This API will find both
built-in parsers and local plugin parsers.
parse(parser_module_name: str, data: str | iterable)
High-level API to easily access the parser. This API will find both
built-in parsers and local plugin parsers.
get_help(parser_module_name: str)
Convenience function to display the help screen for a parser using its
module name.
get_help(parser_module_name: str)
Convenience function to display the help screen for a parser using its
module name.
parser_mod_list()
Get a list of all available parser module names to be used in parse()
and get_help().
parser_mod_list()
Get a list of all available parser module names to be used in parse()
and get_help().
plugin_parser_mod_list()
Get a list of plugin parser module names. This list is a subset of
parser_mod_list().
plugin_parser_mod_list()
Get a list of plugin parser module names. This list is a subset of
parser_mod_list().
"""
from .lib import (__version__, parse, parser_mod_list,
plugin_parser_mod_list, get_help)