Skip to content

Commit abb0d5e

Browse files
authored
Merge pull request #7899 from RetiredWizard/displayioDOC
Doc fix for root_group=None behaviour
2 parents 3ee8d0b + ac82f8f commit abb0d5e

File tree

4 files changed

+12
-3
lines changed

4 files changed

+12
-3
lines changed

shared-bindings/displayio/Display.c

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -426,7 +426,8 @@ MP_PROPERTY_GETTER(displayio_display_bus_obj,
426426

427427
//| root_group: Group
428428
//| """The root group on the display.
429-
//| If the root group is set to ``None``, the default CircuitPython terminal will be shown.
429+
//| If the root group is set to `displayio.CIRCUITPYTHON_TERMINAL`, the default CircuitPython terminal will be shown.
430+
//| If the root group is set to ``None``, no output will be shown.
430431
//| """
431432
STATIC mp_obj_t displayio_display_obj_get_root_group(mp_obj_t self_in) {
432433
displayio_display_obj_t *self = native_display(self_in);

shared-bindings/displayio/EPaperDisplay.c

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -384,7 +384,8 @@ MP_PROPERTY_GETTER(displayio_epaperdisplay_bus_obj,
384384

385385
//| root_group: Group
386386
//| """The root group on the epaper display.
387-
//| If the root group is set to ``None``, the default CircuitPython terminal will be shown.
387+
//| If the root group is set to `displayio.CIRCUITPYTHON_TERMINAL`, the default CircuitPython terminal will be shown.
388+
//| If the root group is set to ``None``, no output will be shown.
388389
//| """
389390
//|
390391
STATIC mp_obj_t displayio_epaperdisplay_obj_get_root_group(mp_obj_t self_in) {

shared-bindings/displayio/__init__.c

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,10 @@
5757
//| <https://learn.adafruit.com/circuitpython-display-support-using-displayio>`_.
5858
//| """
5959

60+
//| CIRCUITPYTHON_TERMINAL: Group
61+
//| """The `displayio.Group` that is the displayed serial terminal (REPL)."""
62+
//|
63+
6064
//| import paralleldisplay
6165
//|
6266

shared-bindings/framebufferio/FramebufferDisplay.c

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -323,7 +323,10 @@ STATIC mp_obj_t framebufferio_framebufferdisplay_obj_fill_row(size_t n_args, con
323323
MP_DEFINE_CONST_FUN_OBJ_KW(framebufferio_framebufferdisplay_fill_row_obj, 1, framebufferio_framebufferdisplay_obj_fill_row);
324324

325325
//| root_group: displayio.Group
326-
//| """The root group on the display."""
326+
//| """The root group on the display.
327+
//| If the root group is set to `displayio.CIRCUITPYTHON_TERMINAL`, the default CircuitPython terminal will be shown.
328+
//| If the root group is set to ``None``, no output will be shown.
329+
//| """
327330
//|
328331
STATIC mp_obj_t framebufferio_framebufferdisplay_obj_get_root_group(mp_obj_t self_in) {
329332
framebufferio_framebufferdisplay_obj_t *self = native_display(self_in);

0 commit comments

Comments
 (0)