Started a new section in API changes, as well as updating information for imshow()

WeatherGod · WeatherGod · commit 44e36cbaa565 · 2011-08-21T14:44:18.000-05:00
diff --git a/doc/api/api_changes.rst b/doc/api/api_changes.rst
@@ -5,7 +5,34 @@ API Changes
 
 This chapter is a log of changes to matplotlib that affect the
 outward-facing API.  If updating matplotlib breaks your scripts, this
-list may help describe what changes may be necessary in your code.
+list may help describe what changes may be necessary in your code or
+help figure out possible sources of the changes you are experiencing.
+
+For new features that were added to matplotlib, please see
+:ref:`whats-new`.
+
+Changes in 1.1.x
+================
+
+* In :meth:`~matplotlib.pyplot.imshow`, setting *interpolation* to 'nearest'
+  will now always mean that the nearest-neighbor interpolation is performed.
+  If you want the no-op interpolation to be performed, choose 'none'.
+
+* There were errors in how the tri-functions were handling input parameters
+  that had to be fixed. If your tri-plots are not working correctly anymore,
+  or you were working around apparent mistakes, please see issue #203 in the
+  github tracker. When in doubt, use kwargs.
+
+* The 'symlog' scale had some bad behavior in previous versions. This has now
+  been fixed and users should now be able to use it without frustrations.
+  The fixes did result in some minor changes in appearance for some users who
+  may have been depending on the bad behavior.
+
+* There is now a common set of markers for all plotting functions. Previously,
+  some markers existed only for :meth:`~matplotlib.pyplot.scatter` or just for
+  :meth:`~matplotlib.pyplot.plot`. This is now no longer the case. This merge
+  did result in a conflict. The string 'd' now means "thin diamond" while
+  'D' will mean "regular diamond".
 
 Changes beyond 0.99.x
 =====================
@@ -50,7 +77,7 @@ Changes beyond 0.99.x
 * The :meth:`matplotlib.axes.Axes.hist` *color* kwarg now accepts
   a sequence of color specs to match a sequence of datasets.
 
-* The :class:'~matplotlib.collections.EllipseCollection' has been
+* The :class:`~matplotlib.collections.EllipseCollection` has been
   changed in two ways:
 
   + There is a new *units* option, 'xy', that scales the ellipse with
diff --git a/doc/users/whats_new.rst b/doc/users/whats_new.rst
@@ -55,7 +55,7 @@ Legend
 
 Jae-Joon Lee has also been working on revamping how plot legends are handled
 in matplotlib. This has resulted in some immediate enhancements. First,
-legends for complex plots such as :func:`~matplotlib.pyplot.stem` plots
+legends for complex plots such as :meth:`~matplotlib.pyplot.stem` plots
 will now display correctly. Second, the 'best' placement of a legend has
 been improved in the presence of NANs.
 
@@ -84,7 +84,7 @@ as 2D plotting, Ben Root has made several improvements to the
 * Ticker offset display added:
 .. plot:: mpl_examples/mplot3d/offset_demo.py
 
-* :func:`~mpl_toolkits.mplot3d.axes3d.Axes3D.contourf`
+* :meth:`~mpl_toolkits.mplot3d.axes3d.Axes3D.contourf`
   gains *zdir* and *offset* kwargs. You can now do this:
 .. plot:: mpl_examples/mplot3d/contourf3d_demo2.py
 
@@ -97,8 +97,8 @@ now been completely removed from matplotlib.
 Markers
 -------
 
-The list of available markers for :func:`~matplotlib.pyplot.plot` and
-:func:`~matplotlib.pyplot.scatter` has now been merged. While they
+The list of available markers for :meth:`~matplotlib.pyplot.plot` and
+:meth:`~matplotlib.pyplot.scatter` has now been merged. While they
 were mostly similar, some markers existed for one function, but not
 the other. This merge did result in a conflict for the 'd' diamond
 marker. Now, 'd' will be interpreated to always mean "thin" diamond
@@ -111,30 +111,33 @@ Other improvements
 
 * Unit support for polar axes and :func:`~matplotlib.axes.Axes.arrow`
 
-* :class:`~matplotlib.projections.polar.PolarAxes` gains
-  'set_theta_direction', 'set_theta_zero_direction' and
-  'set_theta_offset' functions.
+* :class:`~matplotlib.projections.polar.PolarAxes` gains getters and setters for
+  "theta_direction", and "theta_offset" to allow for theta to go in
+  either the clock-wise or counter-clockwise direction and to specify where zero
+  degrees should be placed.
+  :meth:`~matplotlib.projections.polar.PolarAxes.set_theta_zero_location` is an
+  added convenience function.
 
 * Fixed error in argument handling for tri-functions such as
-  :func:`~matplotlib.pyplot.tripcolor`
+  :meth:`~matplotlib.pyplot.tripcolor`
 
-* 'axes.labelweight' parameter added to rcParams.
+* ``axes.labelweight`` parameter added to rcParams.
 
-* For :func:`~matplotlib.pyplot.imshow`, *interpolation='nearest'* will
-  now always perform an interpolation. A 'none' option has been added to
+* For :meth:`~matplotlib.pyplot.imshow`, *interpolation='nearest'* will
+  now always perform an interpolation. A "none" option has been added to
   indicate no interpolation at all.
 
 * An error in the Hammer projection has been fixed.
 
-* *clabel* for :func:`~matplotlib.pyplot.contour` now accepts a callable.
+* *clabel* for :meth:`~matplotlib.pyplot.contour` now accepts a callable.
   Thanks to Daniel Hyams for the original patch!
 
 * Jae-Joon Lee added the :class:`~mpl_toolkits.axes_grid1.axes_divider.HBox`
   and :class:`~mpl_toolkits.axes_grid1.axes_divider.VBox` classes.
 
-* Christoph Gohike improved memory usage in :func:`~matplotlib.pyplot.imshow`.
+* Christoph Gohike improved memory usage in :meth:`~matplotlib.pyplot.imshow`.
 
-* :func:`~matplotlib.pyplot.scatter` now accepts empty inputs.
+* :meth:`~matplotlib.pyplot.scatter` now accepts empty inputs.
 
 * The behavior for 'symlog' scale has been fixed, but this may result
   in some minor changes to existing plots.
diff --git a/lib/matplotlib/axes.py b/lib/matplotlib/axes.py
@@ -6645,7 +6645,7 @@ def imshow(self, X, cmap=None, norm=None, aspect=None,
 
           *interpolation*:
 
-            Acceptable values are *None*, 'nearest', 'bilinear',
+            Acceptable values are *None*, 'none', 'nearest', 'bilinear',
             'bicubic', 'spline16', 'spline36', 'hanning', 'hamming',
             'hermite', 'kaiser', 'quadric', 'catrom', 'gaussian',
             'bessel', 'mitchell', 'sinc', 'lanczos'
@@ -6654,6 +6654,10 @@ def imshow(self, X, cmap=None, norm=None, aspect=None,
             ``image.interpolation``. See also the *filternorm* and
             *filterrad* parameters
 
+            If *interpolation* is 'none', then no interpolation is performed
+            on the Agg, ps and pdf backends. Other backends will fall back to
+            'nearest'.
+
           *norm*: [ None | Normalize ]
             An :class:`matplotlib.colors.Normalize` instance; if
             *None*, default is ``normalization()``.  This scales
diff --git a/lib/matplotlib/image.py b/lib/matplotlib/image.py
@@ -439,7 +439,7 @@ def get_interpolation(self):
 
         One of 'nearest', 'bilinear', 'bicubic', 'spline16', 'spline36', 'hanning',
         'hamming', 'hermite', 'kaiser', 'quadric', 'catrom', 'gaussian',
-        'bessel', 'mitchell', 'sinc', 'lanczos',
+        'bessel', 'mitchell', 'sinc', 'lanczos', or 'none'.
         """
         return self._interpolation
 
