Merge pull request #6424 from efiring/legend_defaults

tacaswell · tacaswell · commit 182354b2f184 · 2016-05-27T22:41:58.000-04:00
API: Legend default style change: smaller, no border
diff --git a/lib/matplotlib/__init__.py b/lib/matplotlib/__init__.py
@@ -861,7 +861,7 @@ def matplotlib_fname():
 _deprecated_ignore_map = {
     }
 
-_obsolete_set = set(['tk.pythoninspect', ])
+_obsolete_set = set(['tk.pythoninspect', 'legend.isaxes'])
 _all_deprecated = set(chain(_deprecated_ignore_map,
                             _deprecated_map, _obsolete_set))
 
@@ -880,6 +880,8 @@ class RcParams(dict):
                     if key not in _all_deprecated)
     msg_depr = "%s is deprecated and replaced with %s; please use the latter."
     msg_depr_ignore = "%s is deprecated and ignored. Use %s"
+    msg_obsolete = ("%s is obsolete. Please remove it from your matplotlibrc "
+                    "and/or style files.")
 
     # validate values on the way in
     def __init__(self, *args, **kwargs):
@@ -897,6 +899,9 @@ def __setitem__(self, key, val):
                 alt = _deprecated_ignore_map[key]
                 warnings.warn(self.msg_depr_ignore % (key, alt))
                 return
+            elif key in _obsolete_set:
+                warnings.warn(self.msg_obsolete % (key,))
+                return
             try:
                 cval = self.validate[key](val)
             except ValueError as ve:
@@ -918,6 +923,10 @@ def __getitem__(self, key):
             warnings.warn(self.msg_depr_ignore % (key, alt))
             key = alt
 
+        elif key in _obsolete_set:
+            warnings.warn(self.msg_obsolete % (key,))
+            return None
+
         val = dict.__getitem__(self, key)
         if inverse_alt is not None:
             return inverse_alt(val)
diff --git a/lib/matplotlib/mpl-data/stylelib/classic.mplstyle b/lib/matplotlib/mpl-data/stylelib/classic.mplstyle
@@ -267,7 +267,6 @@ grid.alpha       :   1.0     # transparency, between 0.0 and 1.0
 legend.fancybox      : False  # if True, use a rounded box for the
                               # legend, else a rectangle
 legend.loc           : upper right
-legend.isaxes        : True   # this option is internally ignored
 legend.numpoints     : 2      # the number of points in the legend line
 legend.fontsize      : large
 legend.borderpad     : 0.4    # border whitespace in fontsize units
@@ -503,4 +502,4 @@ animation.convert_path: convert   # Path to ImageMagick's convert binary.
 animation.convert_args:
 animation.html: none
 
-_internal.classic_mode: True
+_internal.classic_mode: True
diff --git a/lib/matplotlib/rcsetup.py b/lib/matplotlib/rcsetup.py
@@ -1102,25 +1102,19 @@ def validate_hist_bins(s):
 
     #legend properties
     'legend.fancybox': [True, validate_bool],
-
-    # at some point, legend.loc should be changed to 'best'
     'legend.loc': ['best', validate_legend_loc],
-
-    # this option is internally ignored - it never served any useful purpose
-    'legend.isaxes': [True, validate_bool],
-
     # the number of points in the legend line
     'legend.numpoints': [1, validate_int],
     # the number of points in the legend line for scatter
-    'legend.scatterpoints': [3, validate_int],
-    'legend.fontsize': ['large', validate_fontsize],
+    'legend.scatterpoints': [1, validate_int],
+    'legend.fontsize': ['medium', validate_fontsize],
      # the relative size of legend markers vs. original
     'legend.markerscale': [1.0, validate_float],
     'legend.shadow': [False, validate_bool],
      # whether or not to draw a frame around legend
     'legend.frameon': [True, validate_bool],
      # alpha value of the legend frame
-    'legend.framealpha': [None, validate_float_or_None],
+    'legend.framealpha': [0.8, validate_float_or_None],
 
     ## the following dimensions are in fraction of the font size
     'legend.borderpad': [0.4, validate_float],  # units are fontsize
@@ -1140,7 +1134,7 @@ def validate_hist_bins(s):
     'legend.markerscale': [1.0, validate_float],
     'legend.shadow': [False, validate_bool],
     'legend.facecolor': ['inherit', validate_color_or_inherit],
-    'legend.edgecolor': ['k', validate_color_or_inherit],
+    'legend.edgecolor': ['none', validate_color_or_inherit],
 
     # tick properties
     'xtick.top':         [True, validate_bool],   # draw ticks on the top side
diff --git a/lib/mpl_toolkits/tests/baseline_images/test_axes_grid1/inset_locator.png b/lib/mpl_toolkits/tests/baseline_images/test_axes_grid1/inset_locator.png
diff --git a/matplotlibrc.template b/matplotlibrc.template
@@ -388,33 +388,32 @@ backend      : $TEMPLATE_BACKEND
 
 
 ### GRIDS
-#grid.color       :   b0b0b0 # grid color
+#grid.color       :   b0b0b0    # grid color
 #grid.linestyle   :   -         # solid
 #grid.linewidth   :   1.0       # in points
 #grid.alpha       :   1.0       # transparency, between 0.0 and 1.0
 
 ### Legend
-#legend.fancybox      : True  # if True, use a rounded box for the
-                              # legend, else a rectangle
 #legend.loc           : best
-#legend.isaxes        : True
-#legend.numpoints     : 1      # the number of points in the legend line
-#legend.fontsize      : large
-#legend.borderpad     : 0.5    # border whitespace in fontsize units
-#legend.markerscale   : 1.0    # the relative size of legend markers vs. original
-# the following dimensions are in axes coords
-#legend.labelspacing  : 0.5    # the vertical space between the legend entries in fraction of fontsize
-#legend.handlelength  : 2.     # the length of the legend lines in fraction of fontsize
-#legend.handleheight  : 0.7     # the height of the legend handle in fraction of fontsize
-#legend.handletextpad : 0.8    # the space between the legend line and legend text in fraction of fontsize
-#legend.borderaxespad : 0.5   # the border between the axes and legend edge in fraction of fontsize
-#legend.columnspacing : 2.    # the border between the axes and legend edge in fraction of fontsize
+#legend.frameon       : True     # whether or not to draw a frame around legend
+#legend.framealpha    : 0.8      # legend frame transparency
+#legend.facecolor     : inherit  # inherit from axes.facecolor; or color spec
+#legend.edgecolor     : none
+#legend.fancybox      : True     # if True, use a rounded box for the
+                                 # legend, else a rectangle
 #legend.shadow        : False
-#legend.frameon       : True   # whether or not to draw a frame around legend
-#legend.framealpha    : None    # opacity of of legend frame
-#legend.scatterpoints : 3 # number of scatter points
-#legend.facecolor     : inherit
-#legend.edgecolor     : k
+#legend.numpoints     : 1        # the number of marker points in the legend line
+#legend.scatterpoints : 1        # number of scatter points
+#legend.markerscale   : 1.0      # the relative size of legend markers vs. original
+#legend.fontsize      : medium
+# Dimensions as fraction of fontsize:
+#legend.borderpad     : 0.4      # border whitespace
+#legend.labelspacing  : 0.5      # the vertical space between the legend entries
+#legend.handlelength  : 2.0      # the length of the legend lines
+#legend.handleheight  : 0.7      # the height of the legend handle
+#legend.handletextpad : 0.8      # the space between the legend line and legend text
+#legend.borderaxespad : 0.5      # the border between the axes and legend edge
+#legend.columnspacing : 2.0      # column separation
 
 ### FIGURE
 # See http://matplotlib.org/api/figure_api.html#matplotlib.figure.Figure
