summaryrefslogtreecommitdiff
path: root/shared-bindings
diff options
context:
space:
mode:
authorScott Shawcroft <scott@tannewt.org>2019-01-31 10:29:29 -0800
committerScott Shawcroft <scott@tannewt.org>2019-01-31 11:42:15 -0800
commit2c069a5685c9e5bf6b1a081d5566357139c4dff3 (patch)
tree577d84a923be28a1a650ea95e635e994c9606a5d /shared-bindings
parentda206012e206f1b8c292972940ae78e9dbc8cec6 (diff)
Polish up comments
Diffstat (limited to 'shared-bindings')
-rw-r--r--shared-bindings/displayio/Display.c3
-rw-r--r--shared-bindings/terminalio/Terminal.c4
-rw-r--r--shared-bindings/terminalio/__init__.c8
-rw-r--r--shared-bindings/terminalio/__init__.h12
4 files changed, 13 insertions, 14 deletions
diff --git a/shared-bindings/displayio/Display.c b/shared-bindings/displayio/Display.c
index e59905258..0d056bc3b 100644
--- a/shared-bindings/displayio/Display.c
+++ b/shared-bindings/displayio/Display.c
@@ -134,7 +134,8 @@ STATIC mp_obj_t displayio_display_make_new(const mp_obj_type_t *type, size_t n_a
//| .. method:: show(group)
//|
-//| Switches to displaying the given group of layers.
+//| Switches to displaying the given group of layers. When group is None, the default
+//| CircuitPython terminal will be shown.
//|
STATIC mp_obj_t displayio_display_obj_show(mp_obj_t self_in, mp_obj_t group_in) {
displayio_display_obj_t *self = MP_OBJ_TO_PTR(self_in);
diff --git a/shared-bindings/terminalio/Terminal.c b/shared-bindings/terminalio/Terminal.c
index f460f4abd..67c7ead57 100644
--- a/shared-bindings/terminalio/Terminal.c
+++ b/shared-bindings/terminalio/Terminal.c
@@ -39,8 +39,8 @@
//| .. currentmodule:: terminalio
//|
-//| :class:`Terminal` -- manage a
-//| ==============================================================
+//| :class:`Terminal` -- display a character stream with a TileGrid
+//| ================================================================
//|
//| .. class:: Terminal(tilegrid, *, unicode_characters="")
//|
diff --git a/shared-bindings/terminalio/__init__.c b/shared-bindings/terminalio/__init__.c
index 1031124dc..482cb78e6 100644
--- a/shared-bindings/terminalio/__init__.c
+++ b/shared-bindings/terminalio/__init__.c
@@ -3,7 +3,7 @@
*
* The MIT License (MIT)
*
- * Copyright (c) 2018 Scott Shawcroft for Adafruit Industries
+ * Copyright (c) 2019 Scott Shawcroft for Adafruit Industries
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
@@ -34,13 +34,13 @@
#include "py/runtime.h"
-//| :mod:`terminalio` --- MIDI over USB
+//| :mod:`terminalio` --- Displays text in a TileGrid
//| =================================================
//|
//| .. module:: terminalio
-//| :synopsis: MIDI over USB
+//| :synopsis: Displays text in a TileGrid
//|
-//| The `terminalio` module contains classes to transmit and receive MIDI messages over USB
+//| The `terminalio` module contains classes to display a character stream on a display
//|
//| Libraries
//|
diff --git a/shared-bindings/terminalio/__init__.h b/shared-bindings/terminalio/__init__.h
index e81818e04..4be14dfc6 100644
--- a/shared-bindings/terminalio/__init__.h
+++ b/shared-bindings/terminalio/__init__.h
@@ -3,7 +3,7 @@
*
* The MIT License (MIT)
*
- * Copyright (c) 2018 Scott Shawcroft
+ * Copyright (c) 2019 Scott Shawcroft
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
@@ -24,11 +24,9 @@
* THE SOFTWARE.
*/
-#ifndef MICROPY_INCLUDED_SHARED_BINDINGS_USB_MIDI___INIT___H
-#define MICROPY_INCLUDED_SHARED_BINDINGS_USB_MIDI___INIT___H
+#ifndef MICROPY_INCLUDED_SHARED_BINDINGS_TERMINALIO___INIT___H
+#define MICROPY_INCLUDED_SHARED_BINDINGS_TERMINALIO___INIT___H
-#include "py/obj.h"
+// Nothing now.
-extern mp_obj_dict_t usb_midi_module_globals;
-
-#endif // MICROPY_INCLUDED_SHARED_BINDINGS_USB_MIDI___INIT___H
+#endif // MICROPY_INCLUDED_SHARED_BINDINGS_TERMINALIO___INIT___H