summaryrefslogtreecommitdiff
path: root/shared-bindings/_pixelbuf/__init__.c
diff options
context:
space:
mode:
Diffstat (limited to 'shared-bindings/_pixelbuf/__init__.c')
-rw-r--r--shared-bindings/_pixelbuf/__init__.c29
1 files changed, 9 insertions, 20 deletions
diff --git a/shared-bindings/_pixelbuf/__init__.c b/shared-bindings/_pixelbuf/__init__.c
index 744a8a2b8..bfd479fde 100644
--- a/shared-bindings/_pixelbuf/__init__.c
+++ b/shared-bindings/_pixelbuf/__init__.c
@@ -33,33 +33,22 @@
#include "shared-bindings/_pixelbuf/PixelBuf.h"
-//| :mod:`_pixelbuf` --- Fast RGB(W) pixel buffer and helpers
-//| ===========================================================
-
-//| .. module:: _pixelbuf
-//| :synopsis: A fast RGB(W) pixel buffer library for like NeoPixel and DotStar.
+//| """A fast RGB(W) pixel buffer library for like NeoPixel and DotStar.
//|
//| The `_pixelbuf` module provides the :py:class:`PixelBuf` class to accelerate
//| RGB(W) strip/matrix manipulation, such as DotStar and Neopixel.
//|
-//| Byteorders are configured with strings, such as "RGB" or "RGBD".
-//| TODO: Pull in docs from pypixelbuf.
-
-//| Libraries
-//|
-//| .. toctree::
-//| :maxdepth: 3
-//|
-//| PixelBuf
-
+//| Byteorders are configured with strings, such as "RGB" or "RGBD"."""
+// TODO: Pull in docs from pypixelbuf.
-//| .. function:: colorwheel(n)
+//| def colorwheel(n: int) -> Any:
+//| """C implementation of the common wheel() function found in many examples.
+//| Returns the colorwheel RGB value as an integer value for n (usable in :py:class:`PixelBuf`, neopixel, and dotstar)."""
+//| ...
//|
-//| C implementation of the common wheel() function found in many examples.
-//| Returns the colorwheel RGB value as an integer value for n (usable in :py:class:`PixelBuf`, neopixel, and dotstar).
+//| def wheel(n: Any) -> Any:
+//| """Use of wheel() is deprecated. Please use colorwheel()."""
//|
-//| .. function:: wheel(n)
-//| Use of wheel() is deprecated. Please use colorwheel().
STATIC mp_obj_t pixelbuf_colorwheel(mp_obj_t n) {
return MP_OBJ_NEW_SMALL_INT(colorwheel(MP_OBJ_IS_SMALL_INT(n) ? MP_OBJ_SMALL_INT_VALUE(n) : mp_obj_float_get(n)));