Permalink
Browse files

DOC: Add module-level docstring to in-process kernel example.

  • Loading branch information...
1 parent bd40426 commit 28bcbaa6ecb8459ae5a0634ed6bb6debb7c1c695 @epatters epatters committed Sep 24, 2012
Showing with 7 additions and 0 deletions.
  1. +7 −0 docs/examples/frontend/inprocess_qtconsole.py
@@ -1,3 +1,10 @@
+""" A simple example of using the Qt console with an in-process kernel.
+
+We shall see how to create the frontend widget, create an in-process kernel,
+push Python objects into the kernel's namespace, and execute code in the
+kernel, both directly and via the frontend widget.
+"""
+
from IPython.inprocess.ipkernel import InProcessKernel
from IPython.frontend.qt.console.rich_ipython_widget import RichIPythonWidget
from IPython.frontend.qt.inprocess_kernelmanager import QtInProcessKernelManager

0 comments on commit 28bcbaa

Please sign in to comment.