Merge pull request #10091 from anntzer/truefalse

dstansby · web-flow · commit 3700451c1d52 · 2018-01-04T20:06:29.000Z
Replace "True | False" by "bool" in the docs.
diff --git a/lib/matplotlib/axes/_base.py b/lib/matplotlib/axes/_base.py
@@ -445,17 +445,16 @@ def __init__(self, fig, rect,
           *anchor*           [ 'C', 'SW', 'S', 'SE', 'E', 'NE', 'N',
                                'NW', 'W' ]
           *aspect*           [ 'auto' | 'equal' | aspect_ratio ]
-          *autoscale_on*     [ *True* | *False* ] whether or not to
-                             autoscale the *viewlim*
-          *axisbelow*        [ *True* | *False* | 'line'] draw the grids
+          *autoscale_on*     bool; whether to autoscale the *viewlim*
+          *axisbelow*        [ bool | 'line' ] draw the grids
                              and ticks below or above most other artists,
                              or below lines but above patches
           *cursor_props*     a (*float*, *color*) tuple
           *figure*           a :class:`~matplotlib.figure.Figure`
                              instance
-          *frame_on*         a boolean - draw the axes frame
+          *frame_on*         bool; whether to draw the axes frame
           *label*            the axes label
-          *navigate*         [ *True* | *False* ]
+          *navigate*         bool
           *navigate_mode*    [ 'PAN' | 'ZOOM' | None ] the navigation
                              toolbar button status
           *position*         [left, bottom, width, height] in
@@ -465,8 +464,7 @@ def __init__(self, fig, rect,
           *sharey*           an class:`~matplotlib.axes.Axes` instance
                              to share the y-axis with
           *title*            the title string
-          *visible*          [ *True* | *False* ] whether the axes is
-                             visible
+          *visible*          bool, whether the axes is visible
           *xlabel*           the xlabel
           *xlim*             (*xmin*, *xmax*) view limits
           *xscale*           [%(scale)s]
@@ -1289,7 +1287,7 @@ def set_aspect(self, aspect, adjustable=None, anchor=None):
         anchor : None or str or 2-tuple of float, optional
             If not ``None``, this defines where the Axes will be drawn if there
             is extra space due to aspect constraints. The most common way to
-            to specify the anchor are abbreviations of carindal directions:
+            to specify the anchor are abbreviations of cardinal directions:
 
             =====   =====================
             value   description
@@ -2322,14 +2320,14 @@ def autoscale(self, enable=True, axis='both', tight=None):
 
         Parameters
         ----------
-        enable : [True | False | None], optional
+        enable : bool or None, optional
             True (default) turns autoscaling on, False turns it off.
             None leaves the autoscaling state unchanged.
 
         axis : ['both' | 'x' | 'y'], optional
             which axis to operate on; default is 'both'
 
-        tight: [None | True | False], optional
+        tight: bool or None, optional
             If True, set view limits to data limits;
             if False, let the locator and margins expand the view limits;
             if None, use tight scaling if the only artist is an image,
@@ -2666,7 +2664,7 @@ def ticklabel_format(self, **kwargs):
                            be used for numbers outside the range
                            10`m`:sup: to 10`n`:sup:.
                            Use (0,0) to include all numbers.
-          *useOffset*      [True | False | offset]; if True,
+          *useOffset*      [ bool | offset ]; if True,
                            the offset will be calculated as needed;
                            if False, no offset will be used; if a
                            numeric offset is specified, it will be
@@ -2751,7 +2749,7 @@ def locator_params(self, axis='both', tight=None, **kwargs):
         axis : ['both' | 'x' | 'y'], optional
             The axis on which to operate.
 
-        tight : [None | True | False], optional
+        tight : bool or None, optional
             Parameter passed to :meth:`autoscale_view`.
             Default is None, for no change.
 
diff --git a/lib/matplotlib/colorbar.py b/lib/matplotlib/colorbar.py
@@ -88,7 +88,7 @@
                   be given, indicating the lengths of the minimum and
                   maximum colorbar extensions respectively as a
                   fraction of the interior colorbar length.
-    *extendrect*  [ *False* | *True* ]
+    *extendrect*  bool
                   If *False* the minimum and maximum colorbar extensions
                   will be triangular (the default). If *True* the
                   extensions will be rectangular.
@@ -106,8 +106,8 @@
                   used. An alternative
                   :class:`~matplotlib.ticker.Formatter` object may be
                   given instead.
-    *drawedges*   [ False | True ] If true, draw lines at color
-                  boundaries.
+    *drawedges*   bool
+                  Whether to draw lines at color boundaries.
     ============  ====================================================
 
     The following will probably be useful only in the context of
diff --git a/lib/matplotlib/contour.py b/lib/matplotlib/contour.py
@@ -1719,7 +1719,7 @@ def _initialize_x_y(self, z):
             Override axis units by specifying an instance of a
             :class:`matplotlib.units.ConversionInterface`.
 
-          *antialiased*: [ *True* | *False* ]
+          *antialiased*: bool
             enable antialiasing, overriding the defaults.  For
             filled contours, the default is *True*.  For line contours,
             it is taken from rcParams['lines.antialiased'].
diff --git a/lib/matplotlib/figure.py b/lib/matplotlib/figure.py
@@ -256,23 +256,20 @@ def _update_this(self, s, val):
 class Figure(Artist):
 
     """
-    The Figure instance supports callbacks through a *callbacks*
-    attribute which is a :class:`matplotlib.cbook.CallbackRegistry`
-    instance.  The events you can connect to are 'dpi_changed', and
-    the callback will be called with ``func(fig)`` where fig is the
-    :class:`Figure` instance.
+    The Figure instance supports callbacks through a *callbacks* attribute
+    which is a `~.CallbackRegistry` instance.  The events you can connect to
+    are 'dpi_changed', and the callback will be called with ``func(fig)`` where
+    fig is the `Figure` instance.
 
     Attributes
     ----------
     patch
-        The figure patch is drawn by a
-        :class:`matplotlib.patches.Rectangle` instance
+        The `~.Rectangle` instance representing the figure patch.
 
     suppressComposite
         For multiple figure images, the figure will make composite images
-        depending on the renderer option_image_nocomposite function.
-        If *suppressComposite* is ``True`` or ``False``, this will override
-        the renderer.
+        depending on the renderer option_image_nocomposite function.  If
+        *suppressComposite* is a boolean, this will override the renderer.
     """
 
     def __str__(self):
@@ -321,10 +318,10 @@ def __init__(self,
 
         tight_layout : bool
             If ``False`` use *subplotpars*; if ``True`` adjust subplot
-            parameters using :meth:`tight_layout` with default padding.
+            parameters using `~.tight_layout` with default padding.
             When providing a dict containing the keys
             ``pad``, ``w_pad``, ``h_pad``, and ``rect``, the default
-            :meth:`tight_layout` paddings will be overridden.
+            `~.tight_layout` paddings will be overridden.
             Defaults to rc ``figure.autolayout``.
         """
         Artist.__init__(self)
@@ -466,20 +463,26 @@ def _set_dpi(self, dpi, forward=True):
 
     def get_tight_layout(self):
         """
-        Return whether the figure uses :meth:`tight_layout` when drawing.
+        Return whether and how `~.tight_layout` is called when drawing.
         """
         return self._tight
 
     def set_tight_layout(self, tight):
         """
-        Set whether :meth:`tight_layout` is used upon drawing.
-        If None, the rcParams['figure.autolayout'] value will be set.
+        Set whether and how `~.tight_layout` is called when drawing.
 
-        When providing a dict containing the keys `pad`, `w_pad`, `h_pad`
-        and `rect`, the default :meth:`tight_layout` paddings will be
-        overridden.
-
-        ACCEPTS: [True | False | dict | None ]
+        Parameters
+        ----------
+        tight : bool or dict with keys "pad", "w_pad", "h_pad", "rect" or None
+            If a bool, sets whether to call `~.tight_layout` upon drawing.
+            If ``None``, use the ``figure.autolayout`` rcparam instead.
+            If a dict, pass it as kwargs to `~.tight_layout`, overriding the
+            default paddings.
+
+            ..
+                ACCEPTS: [ bool
+                         | dict with keys "pad", "w_pad", "h_pad", "rect"
+                         | None ]
         """
         if tight is None:
             tight = rcParams['figure.autolayout']
diff --git a/lib/matplotlib/legend.py b/lib/matplotlib/legend.py
@@ -1118,49 +1118,48 @@ def set_title(self, title, prop=None):
         self.stale = True
 
     def get_title(self):
-        'Return `~.text.Text` instance for the legend title.'
+        'Return the `~.Text` instance for the legend title.'
         return self._legend_title_box._text
 
     def get_window_extent(self, *args, **kwargs):
         'Return extent of the legend.'
         return self.legendPatch.get_window_extent(*args, **kwargs)
 
     def get_frame_on(self):
-        """
-        Get whether the legend box patch is drawn.
-        """
+        """Get whether the legend box patch is drawn."""
         return self._drawFrame
 
     def set_frame_on(self, b):
         """
-        Set whether the legend box patch is drawn
+        Set whether the legend box patch is drawn.
 
-        ACCEPTS: [ *True* | *False* ]
+        Parameters
+        ----------
+        b : bool
+            ..
+                ACCEPTS: bool
         """
         self._drawFrame = b
         self.stale = True
 
     def get_bbox_to_anchor(self):
-        """
-        Return the bbox that the legend will be anchored.
-        """
+        """Return the bbox that the legend will be anchored to."""
         if self._bbox_to_anchor is None:
             return self.parent.bbox
         else:
             return self._bbox_to_anchor
 
     def set_bbox_to_anchor(self, bbox, transform=None):
         """
-        Set the bbox that the legend will be anchored.
+        Set the bbox that the legend will be anchored to.
 
         *bbox* can be
 
         - A `~.BboxBase` instance
         - A tuple of ``(left, bottom, width, height)`` in the given transform
           (normalized axes coordinate if None)
-        - A tuple of ``[left, bottom]`` where the width and height will be
+        - A tuple of ``(left, bottom)`` where the width and height will be
           assumed to be zero.
-
         """
         if bbox is None:
             self._bbox_to_anchor = None
diff --git a/lib/matplotlib/lines.py b/lib/matplotlib/lines.py
@@ -966,9 +966,13 @@ def get_xydata(self):
 
     def set_antialiased(self, b):
         """
-        True if line should be drawin with antialiased rendering
+        Set whether to use antialiased rendering.
 
-        ACCEPTS: [True | False]
+        Parameters
+        ----------
+        b : bool
+            ..
+                ACCEPTS: bool
         """
         if self._antialiased != b:
             self.stale = True
diff --git a/lib/matplotlib/patches.py b/lib/matplotlib/patches.py
@@ -254,9 +254,13 @@ def get_linestyle(self):
 
     def set_antialiased(self, aa):
         """
-        Set whether to use antialiased rendering
+        Set whether to use antialiased rendering.
 
-        ACCEPTS: [True | False]  or None for default
+        Parameters
+        ----------
+        b : bool or None
+            ..
+                ACCEPTS: bool or None
         """
         if aa is None:
             aa = mpl.rcParams['patch.antialiased']
@@ -413,9 +417,13 @@ def set_ls(self, ls):
 
     def set_fill(self, b):
         """
-        Set whether to fill the patch
+        Set whether to fill the patch.
 
-        ACCEPTS: [True | False]
+        Parameters
+        ----------
+        b : bool
+            ..
+                ACCEPTS: bool
         """
         self._fill = bool(b)
         self._set_facecolor(self._original_facecolor)
@@ -1211,7 +1219,7 @@ def __init__(self, x, y, dx, dy, width=0.001, length_includes_head=False,
           *width*: float (default: 0.001)
             width of full arrow tail
 
-          *length_includes_head*: [True | False] (default: False)
+          *length_includes_head*: bool (default: False)
             True if head is to be counted in calculating the length.
 
           *head_width*: float or None (default: 3*width)
@@ -1227,7 +1235,7 @@ def __init__(self, x, y, dx, dy, width=0.001, length_includes_head=False,
             fraction that the arrow is swept back (0 overhang means
             triangular shape). Can be negative or greater than one.
 
-          *head_starts_at_zero*: [True | False] (default: False)
+          *head_starts_at_zero*: bool (default: False)
             if True, the head starts being drawn at coordinate 0
             instead of ending at coordinate 0.
 
diff --git a/lib/matplotlib/pyplot.py b/lib/matplotlib/pyplot.py
@@ -892,21 +892,18 @@ def axes(arg=None, **kwargs):
         `.Figure.add_axes` respectively. Some common keyword arguments are
         listed below:
 
-        =========   ==============   ==============================================
-        kwarg       Accepts          Description
-        =========   ==============   ==============================================
-        facecolor   color            the axes background color
-        frameon     [True|False]     display the frame?
-        sharex      otherax          current axes shares xaxis attribute
-                                     with otherax
-        sharey      otherax          current axes shares yaxis attribute
-                                     with otherax
-        polar       [True|False]     use a polar axes?
-        aspect      [str | num]      ['equal', 'auto'] or a number.  If a number
-                                     the ratio of y-unit/x-unit in screen-space.
-                                     Also see
-                                     :meth:`~matplotlib.axes.Axes.set_aspect`.
-        =========   ==============   ==============================================
+        ========= =========== =================================================
+        kwarg     Accepts     Description
+        ========= =========== =================================================
+        facecolor color       the axes background color
+        frameon   bool        whether to display the frame
+        sharex    otherax     share x-axis with *otherax*
+        sharey    otherax     share y-axis with *otherax*
+        polar     bool        whether to use polar axes
+        aspect    [str | num] ['equal', 'auto'] or a number.  If a number, the
+                              ratio of y-unit/x-unit in screen-space.  See also
+                              `~.Axes.set_aspect`.
+        ========= =========== =================================================
 
     Returns
     -------
diff --git a/lib/matplotlib/text.py b/lib/matplotlib/text.py
@@ -567,29 +567,30 @@ def set_clip_on(self, b):
         """
         Set whether artist uses clipping.
 
-        When False artists will be visible out side of the axes which
-        can lead to unexpected results.
+        When False, artists will be visible outside of the axes, which can lead
+        to unexpected results.
 
-        ACCEPTS: [True | False]
+        Parameters
+        ----------
+        b : bool
+            ..
+                ACCEPTS: bool
         """
         super(Text, self).set_clip_on(b)
         self._update_clip_properties()
 
     def get_wrap(self):
-        """
-        Returns the wrapping state for the text.
-        """
+        """Returns the wrapping state for the text."""
         return self._wrap
 
     def set_wrap(self, wrap):
         """Sets the wrapping state for the text.
 
-        ..
-            ACCEPTS: bool
-
         Parameters
         ----------
         wrap : bool
+            ..
+                ACCEPTS: bool
         """
         self._wrap = wrap
 
diff --git a/lib/matplotlib/tri/tricontour.py b/lib/matplotlib/tri/tricontour.py
@@ -255,7 +255,7 @@ def _contour_args(self, args, kwargs):
 
         tricontourf-only keyword arguments:
 
-          *antialiased*: [ *True* | *False* ]
+          *antialiased*: bool
             enable antialiasing
 
         Note: tricontourf fills intervals that are closed at the top; that
diff --git a/lib/mpl_toolkits/axes_grid1/axes_grid.py b/lib/mpl_toolkits/axes_grid1/axes_grid.py
diff --git a/lib/mpl_toolkits/axes_grid1/colorbar.py b/lib/mpl_toolkits/axes_grid1/colorbar.py
diff --git a/lib/mpl_toolkits/mplot3d/axes3d.py b/lib/mpl_toolkits/mplot3d/axes3d.py
diff --git a/tutorials/text/text_props.py b/tutorials/text/text_props.py
