diff --git a/docs/readme.md b/docs/readme.md index 1c109fe1..8b7b4606 100644 --- a/docs/readme.md +++ b/docs/readme.md @@ -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(). diff --git a/jc/__init__.py b/jc/__init__.py index df76b67a..bbe03250 100644 --- a/jc/__init__.py +++ b/jc/__init__.py @@ -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)