Skip to content

Commit a2b210d

Browse files
committed
Added documentation comments forewarning of possible API changes
1 parent 545faf2 commit a2b210d

File tree

3 files changed

+15
-0
lines changed

3 files changed

+15
-0
lines changed

lib/matplotlib/colors.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1691,6 +1691,11 @@ class AsinhNorm(Normalize):
16911691
these linear and logarithmic regions is smooth, which may reduce
16921692
the risk of visual artifacts.
16931693
1694+
.. note::
1695+
1696+
This API is provisional and may be revised in the future
1697+
based on early user feedback.
1698+
16941699
Parameters
16951700
----------
16961701
linear_width : float, default: 1

lib/matplotlib/scale.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -508,6 +508,11 @@ class AsinhScale(ScaleBase):
508508
:math:`a \\rightarrow a + {\\cal O}(a^3)`.
509509
For large values of :math:`a` the transformation behaves as
510510
:math:`a \\rightarrow a_0 \\, {\\rm sgn}(a) \\ln |a| + {\\cal O}(1)`.
511+
512+
.. note::
513+
514+
This API is provisional and may be revised in the future
515+
based on early user feedback.
511516
"""
512517

513518
name = 'asinh'

lib/matplotlib/ticker.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2613,6 +2613,11 @@ class AsinhLocator(Locator):
26132613
26142614
This is very unlikely to have any use beyond
26152615
the `~.scale.AsinhScale` class.
2616+
2617+
.. note::
2618+
2619+
This API is provisional and may be revised in the future
2620+
based on early user feedback.
26162621
"""
26172622
def __init__(self, linear_width, numticks=11, symthresh=0.2,
26182623
base=10, subs=None):

0 commit comments

Comments
 (0)