Fix small documentation issues from QuLogic's review

doronbehar · doronbehar · commit 7839ed2abc57 · 2024-10-17T20:01:19.000+03:00
diff --git a/doc/users/next_whats_new/engformatter_offset.rst b/doc/users/next_whats_new/engformatter_offset.rst
@@ -1,14 +1,13 @@
-:class:`matplotlib.ticker.EngFormatter` now computes offset by default
-----------------------------------------------------------------------
+``matplotlib.ticker.EngFormatter`` now computes offset by default
+-----------------------------------------------------------------
 
-:class:`matplotlib.ticker.EngFormatter` has gained the ability to show an
-offset text near the axis. With shared logic with
-:class:`matplotlib.ticker.ScalarFormatter`, it is capable of deciding whether
-the data qualifies having an offset and show it with an appropriate SI quantity
-prefix, and with the supplied ``unit``.
+`matplotlib.ticker.EngFormatter` has gained the ability to show an offset text near the
+axis. Using logic shared with `matplotlib.ticker.ScalarFormatter`, it is capable of
+deciding whether the data qualifies having an offset and show it with an appropriate SI
+quantity prefix, and with the supplied ``unit``.
 
 To enable this new behavior, simply pass ``useOffset=True`` when you
-instantiate :class:`matplotlib.ticker.EngFormatter`. See example
+instantiate `matplotlib.ticker.EngFormatter`. See example
 :doc:`/gallery/ticks/engformatter_offset`.
 
 .. plot:: gallery/ticks/engformatter_offset.py
diff --git a/galleries/examples/ticks/engformatter_offset.py b/galleries/examples/ticks/engformatter_offset.py
@@ -3,7 +3,7 @@
 SI prefixed offsets and natural order of magnitudes
 ===================================================
 
-:class:`matplotlib.ticker.EngFormatter` is capable of computing a natural
+`matplotlib.ticker.EngFormatter` is capable of computing a natural
 offset for your axis data, and presenting it with a standard SI prefix
 automatically calculated.
 
diff --git a/lib/matplotlib/ticker.py b/lib/matplotlib/ticker.py
@@ -1415,7 +1415,7 @@ def __init__(self, unit="", places=None, sep=" ", *, usetex=None,
             guaranteed to get an offset which will make the tick labels exceed
             3 digits. See also `.set_useOffset`.
 
-        .. versionadded:: 3.10
+            .. versionadded:: 3.10
         """
         self.unit = unit
         self.places = places
@@ -1429,9 +1429,10 @@ def __init__(self, unit="", places=None, sep=" ", *, usetex=None,
 
     def __call__(self, x, pos=None):
         """
-        Return the format for tick value *x* at position *pos*. If there is no
-        currently offset in the data, it returns the best engineering formatting
-        that fits the given argument, independently.
+        Return the format for tick value *x* at position *pos*.
+
+        If there is no currently offset in the data, it returns the best
+        engineering formatting that fits the given argument, independently.
         """
         if len(self.locs) == 0 or self.offset == 0:
             return self.fix_minus(self.format_data(x))
