Skip to content

Commit b06c95b

Browse files
committed
Clarified a few points about optional ipy command in Sphinx docs
1 parent 4bb3fd0 commit b06c95b

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

docs/freefeatures.rst

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -218,15 +218,18 @@ be present::
218218
Cmd.__init__(self, use_ipython=True)
219219

220220
The ``ipy`` command enters an interactive IPython_ session. Similar to an
221-
interactive Python session, this shell can access your application instance via ``self``.
222-
However, the ``ipy`` shell cannot call "back" to your application with ``cmd("")`` and
223-
any changes made will not persist between sessions or back in the main application.
221+
interactive Python session, this shell can access your application instance via ``self`` and any changes
222+
to your application made via ``self`` will persist.
223+
However, any local or global variable created within the ``ipy`` shell will not persist.
224+
Within the ``ipy`` shell, you cannot call "back" to your application with ``cmd("")``, however you can run commands
225+
directly like so::
226+
227+
self.onecmd_plus_hooks('help')
224228

225229
IPython_ provides many advantages, including:
226230

227231
* Comprehensive object introspection
228-
* Input history, persistent across sessions
229-
* Caching of output results during a session with automatically generated references
232+
* Get help on objects with ``?``
230233
* Extensible tab completion, with support by default for completion of python variables and keywords
231234

232235
The object introspection and tab completion make IPython particularly efficient for debugging as well as for interactive

0 commit comments

Comments
 (0)