summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorTodd Leonhardt <todd.leonhardt@gmail.com>2017-07-03 16:57:34 -0400
committerTodd Leonhardt <todd.leonhardt@gmail.com>2017-07-03 16:57:34 -0400
commitb06c95b721b7a1096ce78ec3a96726cdbe7026ad (patch)
treef6aed9eaac804fbb7bc2c3332ddc2e23f46e986a /docs
parent4bb3fd02c678bd765cc945ea475e61d7a73f36c8 (diff)
downloadcmd2-git-b06c95b721b7a1096ce78ec3a96726cdbe7026ad.tar.gz
Clarified a few points about optional ipy command in Sphinx docs
Diffstat (limited to 'docs')
-rw-r--r--docs/freefeatures.rst13
1 files changed, 8 insertions, 5 deletions
diff --git a/docs/freefeatures.rst b/docs/freefeatures.rst
index c754bc40..24f9d017 100644
--- a/docs/freefeatures.rst
+++ b/docs/freefeatures.rst
@@ -218,15 +218,18 @@ be present::
Cmd.__init__(self, use_ipython=True)
The ``ipy`` command enters an interactive IPython_ session. Similar to an
-interactive Python session, this shell can access your application instance via ``self``.
-However, the ``ipy`` shell cannot call "back" to your application with ``cmd("")`` and
-any changes made will not persist between sessions or back in the main application.
+interactive Python session, this shell can access your application instance via ``self`` and any changes
+to your application made via ``self`` will persist.
+However, any local or global variable created within the ``ipy`` shell will not persist.
+Within the ``ipy`` shell, you cannot call "back" to your application with ``cmd("")``, however you can run commands
+directly like so::
+
+ self.onecmd_plus_hooks('help')
IPython_ provides many advantages, including:
* Comprehensive object introspection
- * Input history, persistent across sessions
- * Caching of output results during a session with automatically generated references
+ * Get help on objects with ``?``
* Extensible tab completion, with support by default for completion of python variables and keywords
The object introspection and tab completion make IPython particularly efficient for debugging as well as for interactive