Skip to content

Commit 2c069a5

Browse files
committed
Polish up comments
1 parent da20601 commit 2c069a5

File tree

5 files changed

+13
-15
lines changed

5 files changed

+13
-15
lines changed

shared-bindings/displayio/Display.c

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,8 @@ STATIC mp_obj_t displayio_display_make_new(const mp_obj_type_t *type, size_t n_a
134134

135135
//| .. method:: show(group)
136136
//|
137-
//| Switches to displaying the given group of layers.
137+
//| Switches to displaying the given group of layers. When group is None, the default
138+
//| CircuitPython terminal will be shown.
138139
//|
139140
STATIC mp_obj_t displayio_display_obj_show(mp_obj_t self_in, mp_obj_t group_in) {
140141
displayio_display_obj_t *self = MP_OBJ_TO_PTR(self_in);

shared-bindings/terminalio/Terminal.c

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,8 +39,8 @@
3939

4040
//| .. currentmodule:: terminalio
4141
//|
42-
//| :class:`Terminal` -- manage a
43-
//| ==============================================================
42+
//| :class:`Terminal` -- display a character stream with a TileGrid
43+
//| ================================================================
4444
//|
4545
//| .. class:: Terminal(tilegrid, *, unicode_characters="")
4646
//|

shared-bindings/terminalio/__init__.c

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
*
44
* The MIT License (MIT)
55
*
6-
* Copyright (c) 2018 Scott Shawcroft for Adafruit Industries
6+
* Copyright (c) 2019 Scott Shawcroft for Adafruit Industries
77
*
88
* Permission is hereby granted, free of charge, to any person obtaining a copy
99
* of this software and associated documentation files (the "Software"), to deal
@@ -34,13 +34,13 @@
3434

3535
#include "py/runtime.h"
3636

37-
//| :mod:`terminalio` --- MIDI over USB
37+
//| :mod:`terminalio` --- Displays text in a TileGrid
3838
//| =================================================
3939
//|
4040
//| .. module:: terminalio
41-
//| :synopsis: MIDI over USB
41+
//| :synopsis: Displays text in a TileGrid
4242
//|
43-
//| The `terminalio` module contains classes to transmit and receive MIDI messages over USB
43+
//| The `terminalio` module contains classes to display a character stream on a display
4444
//|
4545
//| Libraries
4646
//|

shared-bindings/terminalio/__init__.h

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
*
44
* The MIT License (MIT)
55
*
6-
* Copyright (c) 2018 Scott Shawcroft
6+
* Copyright (c) 2019 Scott Shawcroft
77
*
88
* Permission is hereby granted, free of charge, to any person obtaining a copy
99
* of this software and associated documentation files (the "Software"), to deal
@@ -24,11 +24,9 @@
2424
* THE SOFTWARE.
2525
*/
2626

27-
#ifndef MICROPY_INCLUDED_SHARED_BINDINGS_USB_MIDI___INIT___H
28-
#define MICROPY_INCLUDED_SHARED_BINDINGS_USB_MIDI___INIT___H
27+
#ifndef MICROPY_INCLUDED_SHARED_BINDINGS_TERMINALIO___INIT___H
28+
#define MICROPY_INCLUDED_SHARED_BINDINGS_TERMINALIO___INIT___H
2929

30-
#include "py/obj.h"
30+
// Nothing now.
3131

32-
extern mp_obj_dict_t usb_midi_module_globals;
33-
34-
#endif // MICROPY_INCLUDED_SHARED_BINDINGS_USB_MIDI___INIT___H
32+
#endif // MICROPY_INCLUDED_SHARED_BINDINGS_TERMINALIO___INIT___H

shared-module/displayio/__init__.c

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
#include <string.h>
33
#include "shared-module/displayio/__init__.h"
44

5-
65
#include "shared-bindings/displayio/Bitmap.h"
76
#include "shared-bindings/displayio/Display.h"
87
#include "shared-bindings/displayio/Group.h"

0 commit comments

Comments
 (0)