Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit f5e2f36

Browse files
timhoffmtacaswell
authored andcommitted
Clarify docs of set_powerlimits()
1 parent cb6ae77 commit f5e2f36

File tree

1 file changed

+19
-10
lines changed

1 file changed

+19
-10
lines changed

lib/matplotlib/ticker.py

Lines changed: 19 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -653,19 +653,28 @@ def set_scientific(self, b):
653653
self._scientific = bool(b)
654654

655655
def set_powerlimits(self, lims):
656-
"""
657-
Sets size thresholds for scientific notation.
656+
r"""
657+
Set size thresholds for scientific notation.
658658
659659
Parameters
660660
----------
661-
lims : (min_exp, max_exp)
662-
A tuple containing the powers of 10 that determine the switchover
663-
threshold. Numbers below ``10**min_exp`` and above ``10**max_exp``
664-
will be displayed in scientific notation.
665-
666-
For example, ``formatter.set_powerlimits((-3, 4))`` sets the
667-
pre-2007 default in which scientific notation is used for
668-
numbers less than 1e-3 or greater than 1e4.
661+
lims : (int, int)
662+
A tuple *(min_exp, max_exp)* containing the powers of 10 that
663+
determine the switchover threshold. For a number representable as
664+
:math:`a \times 10^\mathrm{exp}`` with :math:`1 <= |a| < 10`,
665+
scientific notation will be used if ``exp <= min_exp`` or
666+
``exp >= max_exp``.
667+
668+
In particular numbers with *exp* equal to the thresholds are
669+
written in scientific notation.
670+
671+
Typically, *min_exp* will be negative and *max_exp* will be
672+
positive.
673+
674+
For example, ``formatter.set_powerlimits((-3, 4))`` will provide
675+
the following formatting:
676+
:math:`1 \times 10^{-3}, 9.9 \times 10^{-3}, 0.01,`
677+
:math:`9999, 1 \times 10^4`.
669678
670679
See Also
671680
--------

0 commit comments

Comments
 (0)