Adding notes to RGB classes about value scaling.

Author: gtaylor

colormath/color_objects.py

@@ -555,23 +555,23 @@ def _clamp_rgb_coordinate(self, coord):
     @property
     def clamped_rgb_r(self):
         """
-        The clamped (0-1 or 1-255) R value.
+        The clamped (0.0-1.0) R value.
         """
 
         return self._clamp_rgb_coordinate(self.rgb_r)
 
     @property
     def clamped_rgb_g(self):
         """
-        The clamped (0-1 or 1-255) G value.
+        The clamped (0.0-1.0) G value.
         """
 
         return self._clamp_rgb_coordinate(self.rgb_g)
 
     @property
     def clamped_rgb_b(self):
         """
-        The clamped (0-1 or 1-255) B value.
+        The clamped (0.0-1.0) B value.
         """
 
         return self._clamp_rgb_coordinate(self.rgb_b)
@@ -581,9 +581,6 @@ def get_upscaled_value_tuple(self):
         Scales an RGB color object from decimal 0.0-1.0 to int 0-255.
         """
 
-        if self.is_upscaled:
-            return self.get_value_tuple()
-
         # Scale up to 0-255 values.
         rgb_r = int(math.floor(0.5 + self.rgb_r * 255))
         rgb_g = int(math.floor(0.5 + self.rgb_g * 255))
@@ -625,6 +622,10 @@ class sRGBColor(BaseRGBColor):
     """
     Represents an sRGB color.
 
+    .. note:: If you pass in upscaled values, we automatically scale them
+        down to 0.0-1.0. If you need the old upscaled values, you can
+        retrieve them with :py:meth:`get_upscaled_value_tuple`.
+
     :ivar float rgb_r: R coordinate
     :ivar float rgb_g: G coordinate
     :ivar float rgb_b: B coordinate
@@ -654,6 +655,10 @@ class AdobeRGBColor(BaseRGBColor):
     """
     Represents an Adobe RGB color.
 
+    .. note:: If you pass in upscaled values, we automatically scale them
+        down to 0.0-1.0. If you need the old upscaled values, you can
+        retrieve them with :py:meth:`get_upscaled_value_tuple`.
+
     :ivar float rgb_r: R coordinate
     :ivar float rgb_g: G coordinate
     :ivar float rgb_b: B coordinate