Clarify dollar_ticks example and FormatStrFormatter docs.

anntzer · anntzer · commit 0bbaa8c4416f · 2024-01-05T13:25:34.000+01:00
dollar_ticks only uses FormatStrFormatter implicitly.
diff --git a/galleries/examples/ticks/dollar_ticks.py b/galleries/examples/ticks/dollar_ticks.py
@@ -3,10 +3,11 @@
 Dollar ticks
 ============
 
-Use a `~.ticker.FormatStrFormatter` to prepend dollar signs on y-axis labels.
+Use a format string to prepend dollar signs on y-axis labels.
 
 .. redirect-from:: /gallery/pyplots/dollar_ticks
 """
+
 import matplotlib.pyplot as plt
 import numpy as np
 
diff --git a/lib/matplotlib/ticker.py b/lib/matplotlib/ticker.py
@@ -340,6 +340,7 @@ class FormatStrFormatter(Formatter):
     to get a Unicode minus by wrapping the format specifier with $ (e.g.
     "$%g$").
     """
+
     def __init__(self, fmt):
         self.fmt = fmt
 
@@ -358,7 +359,16 @@ class StrMethodFormatter(Formatter):
 
     The field used for the tick value must be labeled *x* and the field used
     for the tick position must be labeled *pos*.
+
+    Negative numeric values will use a dash, not a Unicode minus; use mathtext
+    to get a Unicode minus by wrapping the format specifier with $ (e.g.
+    "${x}$").
+
+    It is typically unnecessary to explicitly construct `.StrMethodFormatter`
+    objects, as `~.Axis.set_major_formatter` also directly accepts the format
+    string itself.
     """
+
     def __init__(self, fmt):
         self.fmt = fmt
 
