Merge pull request #27928 from QuLogic/fix-tools-doc

anntzer · web-flow · commit 1c4c9af3ab6e · 2024-03-15T08:58:07.000+01:00
DOC: Fix syntax for ToolBase.image docstring
diff --git a/lib/matplotlib/backend_tools.py b/lib/matplotlib/backend_tools.py
@@ -99,12 +99,12 @@ class ToolBase:
     """
     Icon filename.
 
-    ``str | None``: Filename of the Toolbar icon; either absolute, or
-    relative to the directory containing the Python source file where the
-    ``Tool.image``class attribute is defined (in the latter case, this cannot
-    be defined as an instance attribute).  In either case, the extension is
-    optional; leaving it off lets individual backends select the icon format
-    they prefer.  If None, the *name* is used as a label in the toolbar button.
+    ``str | None``: Filename of the Toolbar icon; either absolute, or relative to the
+    directory containing the Python source file where the ``Tool.image`` class attribute
+    is defined (in the latter case, this cannot be defined as an instance attribute).
+    In either case, the extension is optional; leaving it off lets individual backends
+    select the icon format they prefer.  If None, the *name* is used as a label in the
+    toolbar button.
     """
 
     def __init__(self, toolmanager, name):
