Updated docstring and created whats_new document

paulkirow · paulkirow · commit 946631817cc9 · 2016-03-20T11:01:03.000-04:00
These changes are meant to document the added parameter to the subplot2grid method
diff --git a/doc/users/whats_new/uptade_subplot2grid.rst b/doc/users/whats_new/uptade_subplot2grid.rst
@@ -0,0 +1,13 @@
+New Firgure Parameter for subplot2grid
+--------------------------------------
+
+A ``fig`` parameter now exists for the method :func:`subplot2grid`.  This allows
+for the figure that the subplots will be created in to be specified.  If ``fig``
+is ``None`` (default) then the method will use the current figure retrieved by
+:func:`gcf`.
+
+Example
+```````
+::
+
+    subplot2grid(shape, loc, rowspan=1, colspan=1, fig=myfig)
diff --git a/lib/matplotlib/pyplot.py b/lib/matplotlib/pyplot.py
@@ -1151,7 +1151,8 @@ def subplot2grid(shape, loc, rowspan=1, colspan=1, fig=None, **kwargs):
     """
     Create a subplot in a grid.  The grid is specified by *shape*, at
     location of *loc*, spanning *rowspan*, *colspan* cells in each
-    direction.  The index for loc is 0-based. ::
+    direction.  The index for loc is 0-based.  The current figure will
+    be used unless *fig* is specified. ::
 
       subplot2grid(shape, loc, rowspan=1, colspan=1)
 
