From 8a43dc936a8100bee5d33102f02ee9434d4a9e14 Mon Sep 17 00:00:00 2001 From: Laurens Valk Date: Tue, 7 Jul 2020 09:22:07 +0200 Subject: [PATCH] doc/signaltypes: add hue placeholder We will have to add a helpful diagram, but having the placeholder allows us to link to it already. --- doc/api/signaltypes.rst | 8 ++++++++ pybricks/_common.py | 2 +- pybricks/pupdevices.py | 2 +- 3 files changed, 10 insertions(+), 2 deletions(-) diff --git a/doc/api/signaltypes.rst b/doc/api/signaltypes.rst index 53b54e9..ee7c4a2 100644 --- a/doc/api/signaltypes.rst +++ b/doc/api/signaltypes.rst @@ -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 diff --git a/pybricks/_common.py b/pybricks/_common.py index 8db83b1..dc15a04 100644 --- a/pybricks/_common.py +++ b/pybricks/_common.py @@ -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. """ diff --git a/pybricks/pupdevices.py b/pybricks/pupdevices.py index dec45af..1d70cdc 100644 --- a/pybricks/pupdevices.py +++ b/pybricks/pupdevices.py @@ -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