Skip to content

Tweak Formatter method docstrings. #31392

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
timhoffm merged 1 commit into from
Mar 26, 2026
+13 −4
Merged

Tweak Formatter method docstrings. #31392

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 13 additions & 4 deletions lib/matplotlib/ticker.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -206,13 +206,18 @@ class Formatter(TickHelper):

def __call__(self, x, pos=None):
"""
Return the format for tick value *x* at position pos.
Return the format for tick value *x* at index *pos*.
``pos=None`` indicates an unspecified location.
"""
raise NotImplementedError('Derived must override')

def format_ticks(self, values):
"""Return the tick labels for all the ticks at once."""
"""
Return the tick labels strings for all *values*.

This method is the public API to generate a meaningful format for a set
of values, e.g. by ensuring an appropriate precision.
"""
self.set_locs(values)
return [self(value, i) for i, value in enumerate(values)]

Expand All @@ -225,9 +230,13 @@ def format_data(self, value):

def format_data_short(self, value):
"""
Return a short string version of the tick value.
Return the mouseover-text representation of a value.

This defaults to the representation returned by `.Formatter.format_data`,
but subclasses may override this.

Defaults to the position-independent long value.
Note: The mouseover text can be customized by setting the
``Axes.fmt_xdata`` and ``Axes.fmt_ydata`` attributes.
"""
return self.format_data(value)

Expand Down
Loading