Skip to content

Commit 1b0c52c

Browse files
authored
Merge pull request #2877 from rhooper/pixelbuf-doc-fix
Pixelbuf doc fix
2 parents 55f78bf + 09fedb3 commit 1b0c52c

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

shared-bindings/_pixelbuf/PixelBuf.c

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ extern const int32_t colorwheel(float pos);
4444

4545
static void parse_byteorder(mp_obj_t byteorder_obj, pixelbuf_byteorder_details_t* parsed);
4646

47-
//| .. currentmodule:: pixelbuf
47+
//| .. currentmodule:: _pixelbuf
4848
//|
4949
//| :class:`PixelBuf` -- A fast RGB[W] pixel buffer for LED and similar devices
5050
//| ===========================================================================
@@ -58,13 +58,13 @@ static void parse_byteorder(mp_obj_t byteorder_obj, pixelbuf_byteorder_details_t
5858
//| When brightness is less than 1.0, a second buffer will be used to store the color values
5959
//| before they are adjusted for brightness.
6060
//|
61-
//| When ``P`` (pwm duration) is present as the 4th character of the byteorder
61+
//| When ``P`` (pwm duration) is present as the first character of the byteorder
6262
//| string, the 4th value in the tuple/list for a pixel is the individual pixel
6363
//| brightness (0.0-1.0) and will enable a Dotstar compatible 1st byte in the
6464
//| output buffer (``buf``).
6565
//|
66-
//| :param ~int size: Number of pixelsx
67-
//| :param ~str byteorder: Byte order string (such as "BGR" or "PBGR")
66+
//| :param ~int size: Number of pixels
67+
//| :param ~str byteorder: Byte order string (such as "BGR" or "BGRP")
6868
//| :param ~float brightness: Brightness (0 to 1.0, default 1.0)
6969
//| :param ~bool auto_write: Whether to automatically write pixels (Default False)
7070
//| :param bytes header: Sequence of bytes to always send before pixel values.
@@ -265,7 +265,7 @@ STATIC mp_obj_t pixelbuf_pixelbuf_show(mp_obj_t self_in) {
265265
}
266266
STATIC MP_DEFINE_CONST_FUN_OBJ_1(pixelbuf_pixelbuf_show_obj, pixelbuf_pixelbuf_show);
267267

268-
//| .. function:: fill(color)
268+
//| .. method:: fill(color)
269269
//|
270270
//| Fills the given pixelbuf with the given color.
271271
//|

0 commit comments

Comments
 (0)