diff --git a/docs/readme.md b/docs/readme.md index 7410dd4f..13c93812 100644 --- a/docs/readme.md +++ b/docs/readme.md @@ -57,29 +57,47 @@ modules directly: ## Available Functions -Use `help(jc.lib)` for details: +Use `help(jc.lib)` for details. + +### parse() parse(parser_module_name: str, data: str | Iterable) -> dict | list[dict] | Iterable[dict] - High-level API to easily access the parser. This API will find both - built-in parsers and local plugin parsers. + +High-level API to easily access the parser. This API will find both +built-in parsers and local plugin parsers. + +### parser_info() parser_info(parser_module_name: str) -> dict - Get the metadata for a particular parser. + +Get the metadata for a particular parser. + +### all_parser_info() all_parser_info() -> list[dict] - Get the metadata for all parsers. + +Get the metadata for all parsers. + +### get_help() get_help(parser_module_name: str) -> None - Convenience function to display the help screen for a parser using - its module name. + +Convenience function to display the help screen for a parser using +its module name. + +### parser_mod_list() parser_mod_list() -> list - Get a list of all available parser module names to be used in - parse(), parser_info(), and get_help(). + +Get a list of all available parser module names to be used in +`parse()`, `parser_info()`, and `get_help()`. + +### plugin_parser_mod_list() plugin_parser_mod_list() -> list - 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(). + +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()`. diff --git a/jc/__init__.py b/jc/__init__.py index a59ba5b2..7b6b6a04 100644 --- a/jc/__init__.py +++ b/jc/__init__.py @@ -53,31 +53,49 @@ modules directly: ## Available Functions -Use `help(jc.lib)` for details: +Use `help(jc.lib)` for details. + +### parse() parse(parser_module_name: str, data: str | Iterable) -> dict | list[dict] | Iterable[dict] - High-level API to easily access the parser. This API will find both - built-in parsers and local plugin parsers. + +High-level API to easily access the parser. This API will find both +built-in parsers and local plugin parsers. + +### parser_info() parser_info(parser_module_name: str) -> dict - Get the metadata for a particular parser. + +Get the metadata for a particular parser. + +### all_parser_info() all_parser_info() -> list[dict] - Get the metadata for all parsers. + +Get the metadata for all parsers. + +### get_help() get_help(parser_module_name: str) -> None - Convenience function to display the help screen for a parser using - its module name. + +Convenience function to display the help screen for a parser using +its module name. + +### parser_mod_list() parser_mod_list() -> list - Get a list of all available parser module names to be used in - parse(), parser_info(), and get_help(). + +Get a list of all available parser module names to be used in +`parse()`, `parser_info()`, and `get_help()`. + +### plugin_parser_mod_list() plugin_parser_mod_list() -> list - 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(). + +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()`. """ from .lib import (__version__, parse, parser_mod_list, plugin_parser_mod_list, parser_info, all_parser_info, get_help)