Update docstrings of the various "colour.utilities.from_range_.*" definition to indicate that scaling occurs in-place.
References
@@ -1297,6 +1297,11 @@ def from_range_1(a, scale_factor=100):
ndarray
:math:`a` scaled from range **'1'**.
+ Warnings
+ --------
+ The scale conversion of :math:`a` variable happens in-place, i.e. :math:`a`
+ will be mutated!
+
Examples
--------
With *Colour* domain-range scale set to **'Reference'**:
@@ -1350,6 +1355,11 @@ def from_range_10(a, scale_factor=10):
ndarray
:math:`a` scaled from range **'10'**.
+ Warnings
+ --------
+ The scale conversion of :math:`a` variable happens in-place, i.e. :math:`a`
+ will be mutated!
+
Examples
--------
With *Colour* domain-range scale set to **'Reference'**:
@@ -1404,6 +1414,11 @@ def from_range_100(a, scale_factor=100):
ndarray
:math:`a` scaled from range **'100'**.
+ Warnings
+ --------
+ The scale conversion of :math:`a` variable happens in-place, i.e. :math:`a`
+ will be mutated!
+
Examples
--------
With *Colour* domain-range scale set to **'Reference'**:
@@ -1452,6 +1467,11 @@ def from_range_degrees(a, scale_factor=360):
Scale factor, usually *numeric* but can be an *array_like* if some
axis need different scaling to be brought from degrees range.
+ Warnings
+ --------
+ The scale conversion of :math:`a` variable happens in-place, i.e. :math:`a`
+ will be mutated!
+
Returns
-------
ndarray
@@ -1514,6 +1534,11 @@ def from_range_int(a, bit_depth=8, dtype=None):
ndarray
:math:`a` scaled from int range.
+ Warnings
+ --------
+ The scale conversion of :math:`a` variable happens in-place, i.e. :math:`a`
+ will be mutated!
+
Notes
-----
- To avoid precision issues and rounding, the scaling is performed on
