Repository navigation
Commit 4900eaf
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -75,9 +75,12 @@ def __init__(self, axis): | |||
| 75 | 75 | The following note is for scale implementers. | |
| 76 | 76 | ||
| 77 | 77 | For back-compatibility reasons, scales take an `~matplotlib.axis.Axis` | |
| 78 | - object as first argument. However, this argument should not | ||
| 79 | - be used: a single scale object should be usable by multiple | ||
| 78 | + object as first argument. We plan to remove it in the future, because | ||
| 79 | + we want to make a scale object usable by multiple | ||
| 80 | 80 | `~matplotlib.axis.Axis`\es at the same time. | |
| 81 | + | ||
| 82 | + The current recommendation for `.ScaleBase` subclasses is to have the | ||
| 83 | + *axis* parameter for API compatibility, but not make use of it. | ||
| 81 | 84 | """ | |
| 82 | 85 | ||
| 83 | 86 | def get_transform(self): | |
@@ -236,6 +239,12 @@ def __init__(self, axis, functions): | |||
| 236 | 239 | ---------- | |
| 237 | 240 | axis : `~matplotlib.axis.Axis` | |
| 238 | 241 | The axis for the scale. | |
| 242 | + | ||
| 243 | + .. note:: | ||
| 244 | + This parameter is unused and about to be removed in the future. | ||
| 245 | + It can already now be left out because of special preprocessing, | ||
| 246 | + so that ``FuncScale(functions)`` is valid. | ||
| 247 | + | ||
| 239 | 248 | functions : (callable, callable) | |
| 240 | 249 | two-tuple of the forward and inverse functions for the scale. | |
| 241 | 250 | The forward function must be monotonic. | |
@@ -336,6 +345,12 @@ def __init__(self, axis=None, *, base=10, subs=None, nonpositive="clip"): | |||
| 336 | 345 | ---------- | |
| 337 | 346 | axis : `~matplotlib.axis.Axis` | |
| 338 | 347 | The axis for the scale. | |
| 348 | + | ||
| 349 | + .. note:: | ||
| 350 | + This parameter is unused and about to be removed in the future. | ||
| 351 | + It can already now be left out because of special preprocessing, | ||
| 352 | + so that ``LogScale(base=2)`` is valid. | ||
| 353 | + | ||
| 339 | 354 | base : float, default: 10 | |
| 340 | 355 | The base of the logarithm. | |
| 341 | 356 | nonpositive : {'clip', 'mask'}, default: 'clip' | |
@@ -485,6 +500,14 @@ class SymmetricalLogScale(ScaleBase): | |||
| 485 | 500 | ||
| 486 | 501 | Parameters | |
| 487 | 502 | ---------- | |
| 503 | + axis : `~matplotlib.axis.Axis` | ||
| 504 | + The axis for the scale. | ||
| 505 | + | ||
| 506 | + .. note:: | ||
| 507 | + This parameter is unused and about to be removed in the future. | ||
| 508 | + It can already now be left out because of special preprocessing, | ||
| 509 | + so that ``SymmetricalLocSacle(base=2)`` is valid. | ||
| 510 | + | ||
| 488 | 511 | base : float, default: 10 | |
| 489 | 512 | The base of the logarithm. | |
| 490 | 513 | ||
@@ -606,6 +629,14 @@ def __init__(self, axis=None, *, linear_width=1.0, | |||
| 606 | 629 | """ | |
| 607 | 630 | Parameters | |
| 608 | 631 | ---------- | |
| 632 | + axis : `~matplotlib.axis.Axis` | ||
| 633 | + The axis for the scale. | ||
| 634 | + | ||
| 635 | + .. note:: | ||
| 636 | + This parameter is unused and about to be removed in the future. | ||
| 637 | + It can already now be left out because of special preprocessing, | ||
| 638 | + so that ``AsinhScale()`` is valid. | ||
| 639 | + | ||
| 609 | 640 | linear_width : float, default: 1 | |
| 610 | 641 | The scale parameter (elsewhere referred to as :math:`a_0`) | |
| 611 | 642 | defining the extent of the quasi-linear region, | |
@@ -706,7 +737,14 @@ def __init__(self, axis=None, nonpositive='mask', *, | |||
| 706 | 737 | Parameters | |
| 707 | 738 | ---------- | |
| 708 | 739 | axis : `~matplotlib.axis.Axis` | |
| 709 | - Currently unused. | ||
| 740 | + The axis for the scale. | ||
| 741 | + | ||
| 742 | + .. note:: | ||
| 743 | + This parameter is unused and about to be removed in the future. | ||
| 744 | + It can already now be left out because of special preprocessing, | ||
| 745 | + so that ``LogitScale()`` is valid. | ||
| 746 | + | ||
| 747 | + Currently unused. | ||
| 710 | 748 | nonpositive : {'mask', 'clip'} | |
| 711 | 749 | Determines the behavior for values beyond the open interval ]0, 1[. | |
| 712 | 750 | They can either be masked as invalid, or clipped to a number very | |
0 commit comments