Merge pull request #7899 from RetiredWizard/displayioDOC

Doc fix for root_group=None behaviour
This commit is contained in:
Dan Halbert 2023-04-24 18:57:29 -04:00 committed by GitHub
commit abb0d5e620
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 12 additions and 3 deletions

View File

@ -426,7 +426,8 @@ MP_PROPERTY_GETTER(displayio_display_bus_obj,
//| root_group: Group
//| """The root group on the display.
//| If the root group is set to ``None``, the default CircuitPython terminal will be shown.
//| If the root group is set to `displayio.CIRCUITPYTHON_TERMINAL`, the default CircuitPython terminal will be shown.
//| If the root group is set to ``None``, no output will be shown.
//| """
STATIC mp_obj_t displayio_display_obj_get_root_group(mp_obj_t self_in) {
displayio_display_obj_t *self = native_display(self_in);

View File

@ -384,7 +384,8 @@ MP_PROPERTY_GETTER(displayio_epaperdisplay_bus_obj,
//| root_group: Group
//| """The root group on the epaper display.
//| If the root group is set to ``None``, the default CircuitPython terminal will be shown.
//| If the root group is set to `displayio.CIRCUITPYTHON_TERMINAL`, the default CircuitPython terminal will be shown.
//| If the root group is set to ``None``, no output will be shown.
//| """
//|
STATIC mp_obj_t displayio_epaperdisplay_obj_get_root_group(mp_obj_t self_in) {

View File

@ -57,6 +57,10 @@
//| <https://learn.adafruit.com/circuitpython-display-support-using-displayio>`_.
//| """
//| CIRCUITPYTHON_TERMINAL: Group
//| """The `displayio.Group` that is the displayed serial terminal (REPL)."""
//|
//| import paralleldisplay
//|

View File

@ -323,7 +323,10 @@ STATIC mp_obj_t framebufferio_framebufferdisplay_obj_fill_row(size_t n_args, con
MP_DEFINE_CONST_FUN_OBJ_KW(framebufferio_framebufferdisplay_fill_row_obj, 1, framebufferio_framebufferdisplay_obj_fill_row);
//| root_group: displayio.Group
//| """The root group on the display."""
//| """The root group on the display.
//| If the root group is set to `displayio.CIRCUITPYTHON_TERMINAL`, the default CircuitPython terminal will be shown.
//| If the root group is set to ``None``, no output will be shown.
//| """
//|
STATIC mp_obj_t framebufferio_framebufferdisplay_obj_get_root_group(mp_obj_t self_in) {
framebufferio_framebufferdisplay_obj_t *self = native_display(self_in);