Merge pull request matplotlib#3007 from cgardn/issue3005

matplotlib#3005 - Removed 'ipython -pylab' references

Author: NelleV

CHANGELOG

@@ -1,3 +1,9 @@
+2014-04-23 Updated references to "ipython -pylab"
+           The preferred method for invoking pylab is now using the
+           "%pylab" magic.
+           -Chris G.
+
+
 2013-05-18 Added support for arbitrary rasterization resolutions to the
            SVG backend. Previously the resolution was hard coded to 72
            dpi. Now the backend class takes a image_dpi argument for

doc/_templates/index.html

@@ -63,9 +63,9 @@ <h1>Introduction</h1>
   For a sampling, see the <a href="{{ pathto('users/screenshots') }}">screenshots</a>, <a href="{{ pathto('gallery') }}">thumbnail</a> gallery,  and
     <a href="examples/index.html">examples</a> directory</p>
 
-  <p>For example, using <tt>"ipython --pylab"</tt> to provide an interactive
-  environment, to generate 10,000 gaussian random numbers and plot a
-  histogram with 100 bins, you simply need to
+  <p>For example, using <tt>"%pylab"</tt> in the IPython shell for
+  an interactive environment, to generate 10,000 gaussian random numbers
+  and plot a histogram with 100 bins, you simply need to
   type</p>
 
   <pre>

doc/users/image_tutorial.rst

@@ -14,7 +14,13 @@ At the very least, you'll need to have access to the
 :func:`~matplotlib.pyplot.imshow` function.  There are a couple of
 ways to do it.  The easy way for an interactive environment::
 
-    $ipython -pylab
+    $ipython
+
+to enter the ipython shell, followed by::
+
+    In [1]: %pylab
+
+to enter the pylab environment.
 
 The imshow function is now directly accessible (it's in your
 `namespace <http://bytebaker.com/2008/07/30/python-namespaces/>`_).
@@ -32,7 +38,7 @@ where you use explicit namespaces and control object creation, etc...
    In [3]: import numpy as np
 
 Examples below will use the latter method, for clarity.  In these
-examples, if you use the -pylab method, you can skip the "mpimg." and
+examples, if you use the %pylab method, you can skip the "mpimg." and
 "plt." prefixes.
 
 .. _importing_data:

doc/users/shell.rst

@@ -29,16 +29,18 @@ matplotlib aware, so when you start ipython in the *pylab* mode.
 
 .. sourcecode:: ipython
 
-    johnh@flag:~> ipython -pylab
+    johnh@flag:~> ipython
     Python 2.4.5 (#4, Apr 12 2008, 09:09:16)
     IPython 0.9.0 -- An enhanced Interactive Python.
 
+    In [1]: %pylab
+
       Welcome to pylab, a matplotlib-based Python environment.
       For more information, type 'help(pylab)'.
 
-    In [1]: x = randn(10000)
+    In [2]: x = randn(10000)
 
-    In [2]: hist(x, 100)
+    In [3]: hist(x, 100)
 
 it sets everything up for you so interactive plotting works as you
 would expect it to.  Call :func:`~matplotlib.pyplot.figure` and a

lib/matplotlib/__init__.py

@@ -12,7 +12,13 @@
 
 or using ipython::
 
-    ipython -pylab
+    ipython
+
+at your terminal, followed by::
+
+    In [1]: %pylab
+
+at the ipython shell prompt.
 
 For the most part, direct use of the object-oriented library is
 encouraged when programming; pyplot is primarily for working

lib/matplotlib/backend_bases.py

@@ -76,7 +76,7 @@ def __call__(self, block=None):
         it is a boolean that overrides all other factors
         determining whether show blocks by calling mainloop().
         The other factors are:
-        it does not block if run inside "ipython --pylab";
+        it does not block if run inside ipython's "%pylab" mode
         it does not block in interactive mode.
         """
         managers = Gcf.get_all_fig_managers()
@@ -100,11 +100,11 @@ def __call__(self, block=None):
             ipython_pylab = not pyplot.show._needmain
             # IPython versions >= 0.10 tack the _needmain
             # attribute onto pyplot.show, and always set
-            # it to False, when in --pylab mode.
+            # it to False, when in %pylab mode.
             ipython_pylab = ipython_pylab and get_backend() != 'WebAgg'
             # TODO: The above is a hack to get the WebAgg backend
-            # working with `ipython --pylab` until proper integration
-            # is implemented.
+            # working with ipython's `%pylab` mode until proper
+            # integration is implemented.
         except AttributeError:
             ipython_pylab = False