Skip to content

Commit 5d024a0

Browse files
committed
Docs formatting
1 parent 2a98af3 commit 5d024a0

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

shared-bindings/aurora_epaper/aurora_framebuffer.c

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,9 @@
3030
#include "shared-module/displayio/__init__.h"
3131

3232
//| class AuroraMemoryFramebuffer:
33-
//| """A framebuffer for Pervasive Displays Aurora E-paper displays. These displays are 2 color only.
33+
//| """A framebuffer for Pervasive Displays Aurora E-paper displays.
34+
//|
35+
//| These displays are 2 color only.
3436
//|
3537
//| This initializes a display and connects it to CircuitPython.
3638
//|
@@ -45,7 +47,7 @@
4547
//| display.refresh()
4648
//|
4749
//| For more information on how these displays are driven see:
48-
//| <https://www.pervasivedisplays.com/wp-content/uploads/2023/02/4P018-00_04_G2_Aurora-Mb_COG_Driver_Interface_Timing_for_small-size_20231107.pdf>
50+
//| https://www.pervasivedisplays.com/wp-content/uploads/2023/02/4P018-00_04_G2_Aurora-Mb_COG_Driver_Interface_Timing_for_small-size_20231107.pdf
4951
//| """
5052
//|
5153
//| def __init__(
@@ -159,7 +161,7 @@ static MP_DEFINE_CONST_FUN_OBJ_1(aurora_epaper_framebuffer_get_free_bus_obj, aur
159161
static mp_obj_t aurora_epaper_framebuffer_set_free_bus(mp_obj_t self_in, mp_obj_t free_bus) {
160162
aurora_epaper_framebuffer_obj_t *self = (aurora_epaper_framebuffer_obj_t *)self_in;
161163
common_hal_aurora_epaper_framebuffer_set_free_bus(self, mp_obj_is_true(free_bus));
162-
return mp_const_none;
164+
return mp_const_none;When True the spi bus passed into the device will be freed on deinit. If you have multiple displays this could be used to keep the other active on soft reset.
163165
}
164166
static MP_DEFINE_CONST_FUN_OBJ_2(aurora_epaper_framebuffer_set_free_bus_obj, aurora_epaper_framebuffer_set_free_bus);
165167

0 commit comments

Comments
 (0)