Skip to content

Commit 37cb6ba

Browse files
committed
RGBMatrix: documentation got behind the code
1 parent 5fcc6d6 commit 37cb6ba

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

shared-bindings/rgbmatrix/RGBMatrix.c

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -135,12 +135,14 @@ STATIC void preflight_pins_or_throw(uint8_t clock_pin, uint8_t *rgb_pins, uint8_
135135

136136
//| :class:`~rgbmatrix.RGBMatrix` displays an in-memory framebuffer to an LED matrix.
137137
//|
138-
//| .. class:: RGBMatrix(width, bit_depth, rgb_pins, addr_pins, clock_pin, latch_pin, output_enable_pin, *, doublebuffer=True, framebuffer=None)
138+
//| .. class:: RGBMatrix(*, width, bit_depth, rgb_pins, addr_pins, clock_pin, latch_pin, output_enable_pin, doublebuffer=True, framebuffer=None, height=0)
139139
//|
140140
//| Create a RGBMatrix object with the given attributes. The height of
141141
//| the display is determined by the number of rgb and address pins:
142142
//| len(rgb_pins) // 3 * 2 ** len(address_pins). With 6 RGB pins and 4
143-
//| address lines, the display will be 32 pixels tall.
143+
//| address lines, the display will be 32 pixels tall. If the optional height
144+
//| parameter is specified and is not 0, it is checked against the calculated
145+
//| height.
144146
//|
145147
//| Up to 30 RGB pins and 8 address pins are supported.
146148
//|

0 commit comments

Comments
 (0)