Merge pull request #31419 from dstansby/str-formatter-example

jklymak · web-flow · commit 4859b7585b7b · 2026-03-28T12:58:25.000-07:00
Add a short example to StrMethodFormatter docstring
diff --git a/lib/matplotlib/ticker.py b/lib/matplotlib/ticker.py
@@ -388,6 +388,12 @@ class StrMethodFormatter(Formatter):
     It is typically unnecessary to explicitly construct `.StrMethodFormatter`
     objects, as `~.Axis.set_major_formatter` directly accepts the format string
     itself.
+
+    Examples
+    --------
+    >>> formatter = StrMethodFormatter("{x} km")
+    >>> formatter(10)
+    "10 km"
     """
 
     def __init__(self, fmt):
