Updated docstring for pixel.increment_brightness()

speratus · Oct 30, 2019 · c464f69 · c464f69
1 parent dca770f
commit c464f69
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/blinkter/pixel.py b/blinkter/pixel.py
@@ -255,6 +255,9 @@ def increment_brightness(self, amount=0.0):
         Increments the overall brightness of this pixel by the specified amount.
         Similar to the :func:`increment` method, this method increases the brightness of the whole pixel by a specified scale
         factor.
+
+        **WARNING**: This method in its current state is essentially useless because it has no effect on pixel brightness.
+        In the future, it will be functional, but more work needs to be done before it reaches that point.
         
         Parameters
         ------------------