From 51eb2c9fa88e406f00bc1f5221e42bdbefe95f48 Mon Sep 17 00:00:00 2001 From: Kelly Brazil Date: Sun, 21 Aug 2022 16:23:56 -0700 Subject: [PATCH] doc update --- docs/readme.md | 7 ++++++- jc/__init__.py | 7 ++++++- 2 files changed, 12 insertions(+), 2 deletions(-) diff --git a/docs/readme.md b/docs/readme.md index c87a0766..2c0d7e6d 100644 --- a/docs/readme.md +++ b/docs/readme.md @@ -11,12 +11,17 @@ and file-types to dictionaries and lists of dictionaries. ## Interactive Documentation +Using `jc` in your python programs: + >>> help('jc') >>> help('jc.lib') + >>> jc.get_help('parser_module_name') + +Developing `jc` parsers: + >>> help('jc.utils') >>> help('jc.streaming') >>> help('jc.parsers.universal') - >>> jc.get_help('parser_module_name') ## Online Documentation diff --git a/jc/__init__.py b/jc/__init__.py index bbf8ab97..fd297d59 100644 --- a/jc/__init__.py +++ b/jc/__init__.py @@ -7,12 +7,17 @@ and file-types to dictionaries and lists of dictionaries. ## Interactive Documentation +Using `jc` in your python programs: + >>> help('jc') >>> help('jc.lib') + >>> jc.get_help('parser_module_name') + +Developing `jc` parsers: + >>> help('jc.utils') >>> help('jc.streaming') >>> help('jc.parsers.universal') - >>> jc.get_help('parser_module_name') ## Online Documentation