FIX: rename to FuncScale

jklymak · jklymak · commit 74679ab948a9 · 2018-11-25T08:46:50.000-08:00
diff --git a/examples/scales/custom_scale.py b/examples/scales/custom_scale.py
@@ -8,7 +8,7 @@
 
 Unless you are making special use of the `~.Transform` class, you probably
 don't need to use this verbose method, and instead can use
-`~.matplotlib.scale.ArbitraryScale` and the ``'arbitrary'`` option of
+`~.matplotlib.scale.FuncScale` and the ``'function'`` option of
 `~.matplotlib.axes.Axes.set_xscale` and `~.matplotlib.axes.Axes.set_yscale`.
 See the last example in :doc:`/gallery/scales/scales`.
 """
diff --git a/examples/scales/scales.py b/examples/scales/scales.py
@@ -5,7 +5,7 @@
 
 Illustrate the scale transformations applied to axes, e.g. log, symlog, logit.
 
-The last two examples are examples of using the ``'arbitrary'`` scale by
+The last two examples are examples of using the ``'function'`` scale by
 supplying forward and inverse functions for the scale transformation.
 """
 import numpy as np
@@ -57,7 +57,7 @@
 ax.yaxis.set_minor_formatter(NullFormatter())
 
 
-# Arbitrary x**(1/2)
+# Function x**(1/2)
 def forward(x):
     return x**(1/2)
 
@@ -68,14 +68,14 @@ def inverse(x):
 
 ax = axs[2, 0]
 ax.plot(x, y)
-ax.set_yscale('arbitrary', functions=(forward, inverse))
-ax.set_title('arbitrary: $x^{1/2}$')
+ax.set_yscale('function', functions=(forward, inverse))
+ax.set_title('function: $x^{1/2}$')
 ax.grid(True)
 ax.yaxis.set_major_locator(FixedLocator(np.arange(0, 1, 0.2)**2))
 ax.yaxis.set_major_locator(FixedLocator(np.arange(0, 1, 0.2)))
 
 
-# Arbitrary Mercator transform
+# Function Mercator transform
 def forward(a):
     a = np.deg2rad(a)
     # mask values too close to +/- 90, which are ill-defined.
@@ -99,8 +99,8 @@ def inverse(a):
 
 ax.plot(t, s, '-', lw=2)
 
-ax.set_yscale('arbitrary', functions=(forward, inverse))
-ax.set_title('arbitrary: Mercator')
+ax.set_yscale('function', functions=(forward, inverse))
+ax.set_title('function: Mercator')
 ax.grid(True)
 ax.set_xlim([-180, 180])
 ax.yaxis.set_minor_formatter(NullFormatter())
@@ -126,4 +126,4 @@ def inverse(a):
 matplotlib.scale.LogScale
 matplotlib.scale.LinearScale
 matplotlib.scale.SymmetricalLogScale
-matplotlib.scale.ArbitraryScale
+matplotlib.scale.FuncScale
diff --git a/lib/matplotlib/scale.py b/lib/matplotlib/scale.py
@@ -82,7 +82,7 @@ def get_transform(self):
         return IdentityTransform()
 
 
-class ArbitraryTransform(Transform):
+class FuncTransform(Transform):
      """
      A simple transform that takes and arbitrary function for the
      forward and inverse transform.
@@ -114,22 +114,22 @@ def forward(values: array-like) ->
              self._forward = forward
              self._inverse = inverse
          else:
-             raise ValueError('arguments to ArbitraryTransform must '
+             raise ValueError('arguments to FuncTransform must '
                               'be functions')
 
      def transform_non_affine(self, values):
          return self._forward(values)
 
      def inverted(self):
-         return ArbitraryTransform(self._inverse, self._forward)
+         return FuncTransform(self._inverse, self._forward)
 
 
-class ArbitraryScale(ScaleBase):
+class FuncScale(ScaleBase):
      """
-     Provide an arbitrary scale for the axis.
+     Provide an arbitrary scale with user-supplied function for the axis.
      """
 
-     name = 'arbitrary'
+     name = 'function'
 
      def __init__(self, axis, functions):
          """
@@ -149,7 +149,7 @@ def forward(values: array-like) ->
                        array-likeThe forward function for the transform
          """
          forward, inverse = functions
-         transform = ArbitraryTransform(forward, inverse)
+         transform = FuncTransform(forward, inverse)
          self._transform = transform
 
      def get_transform(self):
@@ -636,7 +636,7 @@ def limit_range_for_scale(self, vmin, vmax, minpos):
     'log':    LogScale,
     'symlog': SymmetricalLogScale,
     'logit':  LogitScale,
-    'arbitrary': ArbitraryScale,
+    'function': FuncScale,
     }
 
 
diff --git a/lib/matplotlib/tests/baseline_images/test_scale/function_scales.png b/lib/matplotlib/tests/baseline_images/test_scale/function_scales.png
diff --git a/lib/matplotlib/tests/test_scale.py b/lib/matplotlib/tests/test_scale.py
@@ -152,9 +152,9 @@ def test_invalid_log_lims():
     assert ax.get_ylim() == original_ylim
 
 
-@image_comparison(baseline_images=['arbitrary_scales'], remove_text=True,
+@image_comparison(baseline_images=['function_scales'], remove_text=True,
                   extensions=['png'], style='mpl20')
-def test_arbitrary_scale():
+def test_function_scale():
     def inverse(x):
         return x**2
 
@@ -169,5 +169,5 @@ def forward(x):
     x = np.arange(1, 1000)
 
     ax.plot(x, x)
-    ax.set_xscale('arbitrary', functions=(forward, inverse))
+    ax.set_xscale('function', functions=(forward, inverse))
     ax.set_xlim(1, 1000)
