Add a short example to StrMethodFormatter docstring

dstansby · dstansby · commit a8310dc01bd1 · 2026-03-28T17:54:07.000Z
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):
