documented new kwarg handling for grid

jdh2358 · jdh2358 · commit 064ea1265356 · 2006-03-18T03:04:52.000Z
svn path=/trunk/matplotlib/; revision=2164
diff --git a/lib/matplotlib/axes.py b/lib/matplotlib/axes.py
@@ -1752,8 +1752,19 @@ def get_autoscale_on(self):
     def grid(self, b=None, **kwargs):
         """
         Set the axes grids on or off; b is a boolean
-        if b is None, toggle the grid state
+
+        if b is None and len(kwargs)==0, toggle the grid state.  if
+        kwargs are supplied, it is assumed that you want a grid and b
+        is thus set to True
+
+        kawrgs are used to set the grid line properties, eg
+
+          ax.grid(color='r', linestyle='-', linewidth=2)
+
+        See getp(line) for more information on valid keywords for line
+        properties.
         """
+        if len(kwargs): b = True
         self.xaxis.grid(b, **kwargs)
         self.yaxis.grid(b, **kwargs)
 
diff --git a/lib/matplotlib/axis.py b/lib/matplotlib/axis.py
@@ -717,8 +717,15 @@ def grid(self, b=None, which='major', **kwargs):
         Set the axis grid on or off; b is a boolean use which =
         'major' | 'minor' to set the grid for major or minor ticks
 
-        if b is None, toggle the grid state
+        if b is None and len(kwargs)==0, toggle the grid state.  If
+        kwargs are supplied, it is assumed you want the grid on and b
+        will be set to True
+
+        kwargs are used to set the line properties of the grids, eg,
+
+          xax.grid(color='r', linestyle='-', linewidth=2)
         """
+        if len(kwargs): b = True
         if which.lower().find('minor')>=0:
             if b is None: self._gridOnMinor = not self._gridOnMinor
             else: self._gridOnMinor = b
