From 28bcbaa6ecb8459ae5a0634ed6bb6debb7c1c695 2012-09-24 15:26:30
From: epatters <ejpatters@gmail.com>
Date: 2012-09-24 15:26:30
Subject: [PATCH] DOC: Add module-level docstring to in-process kernel example.

---

diff --git a/docs/examples/frontend/inprocess_qtconsole.py b/docs/examples/frontend/inprocess_qtconsole.py
index ec9ab1c..722a8af 100644
--- a/docs/examples/frontend/inprocess_qtconsole.py
+++ b/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