From 64a4fa3cb9b1ffa0440b5c8539049e3a209e609d 2013-12-19 02:24:32 From: chebee7i Date: 2013-12-19 02:24:32 Subject: [PATCH] Docstring updates. --- diff --git a/IPython/sphinxext/custom_doctests.py b/IPython/sphinxext/custom_doctests.py index 2a80f9a..7678fd6 100644 --- a/IPython/sphinxext/custom_doctests.py +++ b/IPython/sphinxext/custom_doctests.py @@ -1,5 +1,5 @@ """ -Module containing additional handlers for the IPython directive's @doctest. +Handlers for IPythonDirective's @doctest pseudo-decorator. The Sphinx extension that provides support for embedded IPython code provides a pseudo-decorator @doctest, which treats the input/output block as a diff --git a/IPython/sphinxext/ipython_directive.py b/IPython/sphinxext/ipython_directive.py index 6630190..c3af1fd 100644 --- a/IPython/sphinxext/ipython_directive.py +++ b/IPython/sphinxext/ipython_directive.py @@ -1,5 +1,6 @@ # -*- coding: utf-8 -*- -"""Sphinx directive to support embedded IPython code. +""" +Sphinx directive to support embedded IPython code. This directive allows pasting of entire interactive IPython sessions, prompts and all, and their code will actually get re-executed at doc build time, with