From 7e40227a5f815e68dab85f6749a530a7da1bbb1d Mon Sep 17 00:00:00 2001 From: Hrishikesh Terdalkar Date: Thu, 17 Mar 2022 12:50:32 +0530 Subject: [PATCH] docs: update documentation about REPL command `search` --- README.rst | 16 ++++++++++++++-- USAGE.rst | 16 ++++++++++++++-- 2 files changed, 28 insertions(+), 4 deletions(-) diff --git a/README.rst b/README.rst index e51d275..572789b 100644 --- a/README.rst +++ b/README.rst @@ -261,12 +261,24 @@ REPL Session Example Documented commands (type help ): ======================================== - EOF debug exit info limit shell stats use - available dicts help input_scheme output_scheme show update version + EOF dicts info output_scheme show use + available exit input_scheme search stats version + debug help limit shell update (CDSL::None) help available Display a list of dictionaries available in CDSL + (CDSL::None) help search + + Search in the active dictionaries + + Note + ---- + * Searching in the active dictionaries is also the default action. + * In general, we do not need to use this command explicitly unless we + want to search the command keywords, such as, `available` `search`, + `version`, `help` etc. in the active dictionaries. + (CDSL::None) help dicts Display a list of dictionaries available locally diff --git a/USAGE.rst b/USAGE.rst index 68e2392..021236f 100644 --- a/USAGE.rst +++ b/USAGE.rst @@ -207,12 +207,24 @@ REPL Session Example Documented commands (type help ): ======================================== - EOF debug exit info limit shell stats use - available dicts help input_scheme output_scheme show update version + EOF dicts info output_scheme show use + available exit input_scheme search stats version + debug help limit shell update (CDSL::None) help available Display a list of dictionaries available in CDSL + (CDSL::None) help search + + Search in the active dictionaries + + Note + ---- + * Searching in the active dictionaries is also the default action. + * In general, we do not need to use this command explicitly unless we + want to search the command keywords, such as, `available` `search`, + `version`, `help` etc. in the active dictionaries. + (CDSL::None) help dicts Display a list of dictionaries available locally