Merge pull request matplotlib#29172 from anntzer/clean

Minor cleanups to docstrings, comments, and error messages.

Author: timhoffm

galleries/examples/text_labels_and_annotations/dfrac_demo.py

@@ -5,13 +5,13 @@
 
 In this example, the differences between the \\dfrac and \\frac TeX macros are
 illustrated; in particular, the difference between display style and text style
-fractions when using Mathtex.
+fractions when using Mathtext.
 
 .. versionadded:: 2.1
 
 .. note::
     To use \\dfrac with the LaTeX engine (text.usetex : True), you need to
-    import the amsmath package with the text.latex.preamble rc, which is
+    import the amsmath package with :rc:`text.latex.preamble`, which is
     an unsupported feature; therefore, it is probably a better idea to just
     use the \\displaystyle option before the \\frac macro to get this behavior
     with the LaTeX engine.

lib/matplotlib/pyplot.py

@@ -818,8 +818,7 @@ def xkcd(
 
     Notes
     -----
-    This function works by a number of rcParams, so it will probably
-    override others you have set before.
+    This function works by a number of rcParams, overriding those set before.
 
     If you want the effects of this function to be temporary, it can
     be used as a context manager, for example::
@@ -1192,9 +1191,7 @@ def close(fig: None | int | str | Figure | Literal["all"] = None) -> None:
         _pylab_helpers.Gcf.destroy_all()
     elif isinstance(fig, int):
         _pylab_helpers.Gcf.destroy(fig)
-    elif hasattr(fig, 'int'):
-        # if we are dealing with a type UUID, we
-        # can use its integer representation
+    elif hasattr(fig, 'int'):  # UUIDs get converted to ints by figure().
         _pylab_helpers.Gcf.destroy(fig.int)
     elif isinstance(fig, str):
         all_labels = get_figlabels()
@@ -1204,8 +1201,8 @@ def close(fig: None | int | str | Figure | Literal["all"] = None) -> None:
     elif isinstance(fig, Figure):
         _pylab_helpers.Gcf.destroy_fig(fig)
     else:
-        raise TypeError("close() argument must be a Figure, an int, a string, "
-                        "or None, not %s" % type(fig))
+        _api.check_isinstance(  # type: ignore[unreachable]
+            (Figure, int, str, None), fig=fig)
 
 
 def clf() -> None:

lib/matplotlib/tests/test_pyplot.py

@@ -163,8 +163,9 @@ def test_close():
     try:
         plt.close(1.1)
     except TypeError as e:
-        assert str(e) == "close() argument must be a Figure, an int, " \
-                         "a string, or None, not <class 'float'>"
+        assert str(e) == (
+            "'fig' must be an instance of matplotlib.figure.Figure, int, str "
+            "or None, not a float")
 
 
 def test_subplot_reuse():

lib/matplotlib/ticker.py

@@ -1741,6 +1741,7 @@ class IndexLocator(Locator):
     IndexLocator assumes index plotting; i.e., that the ticks are placed at integer
     values in the range between 0 and len(data) inclusive.
     """
+
     def __init__(self, base, offset):
         """Place ticks every *base* data point, starting at *offset*."""
         self._base = base
@@ -1793,9 +1794,7 @@ def tick_values(self, vmin, vmax):
 
         .. note::
 
-            Because the values are fixed, vmin and vmax are not used in this
-            method.
-
+            Because the values are fixed, *vmin* and *vmax* are not used.
         """
         if self.nbins is None:
             return self.locs
@@ -1810,7 +1809,7 @@ def tick_values(self, vmin, vmax):
 
 class NullLocator(Locator):
     """
-    No ticks
+    Place no ticks.
     """
 
     def __call__(self):
@@ -1822,8 +1821,7 @@ def tick_values(self, vmin, vmax):
 
         .. note::
 
-            Because the values are Null, vmin and vmax are not used in this
-            method.
+            Because there are no ticks, *vmin* and *vmax* are not used.
         """
         return []
 
@@ -1832,12 +1830,11 @@ class LinearLocator(Locator):
     """
     Place ticks at evenly spaced values.
 
-    The first time this function is called it will try to set the
-    number of ticks to make a nice tick partitioning.  Thereafter, the
-    number of ticks will be fixed so that interactive navigation will
-    be nice
-
+    The first time this function is called, it will try to set the number of
+    ticks to make a nice tick partitioning.  Thereafter, the number of ticks
+    will be fixed to avoid jumping during interactive navigation.
     """
+
     def __init__(self, numticks=None, presets=None):
         """
         Parameters
@@ -1997,6 +1994,7 @@ class _Edge_integer:
     Take floating-point precision limitations into account when calculating
     tick locations as integer multiples of a step.
     """
+
     def __init__(self, step, offset):
         """
         Parameters