Minor fixes re: grid_minor keybinding.

anntzer · anntzer · commit 0658c2b842d7 · 2016-08-09T09:57:29.000-07:00
diff --git a/doc/users/navigation_toolbar.rst b/doc/users/navigation_toolbar.rst
@@ -99,8 +99,8 @@ Close all plots                    **shift** + **w**
 Constrain pan/zoom to x axis       hold **x** when panning/zooming with mouse
 Constrain pan/zoom to y axis       hold **y** when panning/zooming with mouse
 Preserve aspect ratio              hold **CONTROL** when panning/zooming with mouse
-Toggle major grid                  **g** when mouse is over an axes
-Toggle major and minor grid        **G** when mouse is over an axes
+Toggle major grids                 **g** when mouse is over an axes
+Toggle minor grids                 **G** when mouse is over an axes
 Toggle x axis scale (log/linear)   **L** or **k**  when mouse is over an axes
 Toggle y axis scale (log/linear)   **l** when mouse is over an axes
 ================================== =================================================
diff --git a/lib/matplotlib/backend_tools.py b/lib/matplotlib/backend_tools.py
@@ -400,8 +400,7 @@ def trigger(self, sender, event, data=None):
 
 
 class _ToolGridBase(ToolBase):
-    """Common functionality between ToolGrid and ToolMinorGrid.
-    """
+    """Common functionality between ToolGrid and ToolMinorGrid."""
 
     _cycle = [(False, False), (True, False), (True, True), (False, True)]
 
@@ -420,7 +419,8 @@ def trigger(self, sender, event, data=None):
 
     @staticmethod
     def _get_uniform_grid_state(ticks):
-        """Check whether all grid lines are in the same visibility state.
+        """
+        Check whether all grid lines are in the same visibility state.
 
         Returns True/False if all grid lines are on or off, None if they are
         not all in the same state.
@@ -443,7 +443,7 @@ def _get_next_grid_states(self, ax):
         x_state, y_state = map(self._get_uniform_grid_state,
                                [ax.xaxis.majorTicks, ax.yaxis.majorTicks])
         cycle = self._cycle
-        # Bail out if major grids are not in a uniform state.
+        # Bail out (via ValueError) if major grids are not in a uniform state.
         x_state, y_state = (
             cycle[(cycle.index((x_state, y_state)) + 1) % len(cycle)])
         return x_state, y_state, "major"
@@ -463,7 +463,7 @@ def _get_next_grid_states(self, ax):
         x_state, y_state = map(self._get_uniform_grid_state,
                                [ax.xaxis.minorTicks, ax.yaxis.minorTicks])
         cycle = self._cycle
-        # Bail out if minor grids are not in a uniform state.
+        # Bail out (via ValueError) if minor grids are not in a uniform state.
         x_state, y_state = (
             cycle[(cycle.index((x_state, y_state)) + 1) % len(cycle)])
         return x_state, y_state, "both"
diff --git a/matplotlibrc.template b/matplotlibrc.template
@@ -584,8 +584,8 @@ backend      : $TEMPLATE_BACKEND
 #keymap.zoom : o                     # zoom mnemonic
 #keymap.save : s                     # saving current figure
 #keymap.quit : ctrl+w, cmd+w         # close the current figure
-#keymap.grid : g                     # switching on/off a grid in current axes
-#keymap.grid_minor : G               # switching on/off a grid in current axes
+#keymap.grid : g                     # switching on/off major grids in current axes
+#keymap.grid_minor : G               # switching on/off minor grids in current axes
 #keymap.yscale : l                   # toggle scaling of y-axes ('log'/'linear')
 #keymap.xscale : L, k                # toggle scaling of x-axes ('log'/'linear')
 #keymap.all_axes : a                 # enable all axes
