doc/signaltypes: add hue placeholder

We will have to add a helpful diagram, but having the placeholder allows us to link to it already.
This commit is contained in:
Laurens Valk
2020-07-07 09:44:16 +02:00
committed by laurensvalk
parent 7d1fbe9ce9
commit 8a43dc936a
3 changed files with 10 additions and 2 deletions
+8
View File
@@ -242,3 +242,11 @@ Fahrenheit (°F) or Kelvin (K), you can use the following conversion formulas:
:math:`°\!F = °\!C \cdot \frac{9}{5} + 32`.
:math:`K = °\!C + 273.15`.
.. _hue:
hue: deg
--------------
Hue of a color (0-359 degrees).
TODO: diagram
+1 -1
View File
@@ -448,7 +448,7 @@ class ColorLight:
"""Set the hue, saturation and brightness of the light.
Arguments:
hue (:ref:`angle`): Hue of the color.
hue (:ref:`hue`): Hue of the color.
saturation (:ref:`percentage`): Saturation of the color.
value (:ref:`percentage`): Brightness value of the color.
"""
+1 -1
View File
@@ -212,7 +212,7 @@ class ColorSensor:
:returns: Tuple with the hue, saturation, and value
(brightness) of the color.
:rtype: (:ref:`angle`, :ref:`percentage`, :ref:`percentage`)
:rtype: (:ref:`hue`, :ref:`percentage`, :ref:`percentage`)
"""
pass