Skip to content

Commit e336dc9

Browse files
committed
update explanation of height; it is optional
1 parent 2dcc0d2 commit e336dc9

File tree

1 file changed

+1
-2
lines changed

1 file changed

+1
-2
lines changed

shared-bindings/rgbmatrix/RGBMatrix.c

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -189,7 +189,6 @@ STATIC void preflight_pins_or_throw(uint8_t clock_pin, uint8_t *rgb_pins, uint8_
189189
//| `framebufferio.FramebufferDisplay`.
190190
//|
191191
//| :param int width: The overall width of the whole matrix in pixels. For a matrix with multiple panels in row, this is the width of a single panel times the number of panels across.
192-
//| :param int height: The overall height of the whole matrix in pixels. For a matrix with multiple rows of panels, this is the height of a single panel times the number of panels down.
193192
//| :param int tile: In a multi-row matrix, the number of rows of panels
194193
//| :param int bit_depth: The color depth of the matrix. A value of 1 gives 8 colors, a value of 2 gives 64 colors, and so on. Increasing bit depth increases the CPU and RAM usage of the RGBMatrix, and may lower the panel refresh rate. The framebuffer is always in RGB565 format regardless of the bit depth setting
195194
//| :param bool serpentine: In a multi-row matrix, True when alternate rows of panels are rotated 180°, which can reduce wiring length
@@ -200,7 +199,7 @@ STATIC void preflight_pins_or_throw(uint8_t clock_pin, uint8_t *rgb_pins, uint8_
200199
//| :param digitalio.DigitalInOut output_enable_pin: The matrix's output enable pin
201200
//| :param bool doublebuffer: True if the output is double-buffered
202201
//| :param Optional[WriteableBuffer] framebuffer: A pre-allocated framebuffer to use. If unspecified, a framebuffer is allocated
203-
//|
202+
//| :param int height: The optional overall height of the whole matrix in pixels. This value is not required because it can be calculated as described above.
204203
//| """
205204

206205
STATIC mp_obj_t rgbmatrix_rgbmatrix_make_new(const mp_obj_type_t *type, size_t n_args, size_t n_kw, const mp_obj_t *all_args) {

0 commit comments

Comments
 (0)