Skip to content

Commit 7b0f6ff

Browse files
author
caternuson
committed
README and docstring update
1 parent 1d6f795 commit 7b0f6ff

File tree

2 files changed

+8
-5
lines changed

2 files changed

+8
-5
lines changed

README.rst

+1-4
Original file line numberDiff line numberDiff line change
@@ -58,10 +58,8 @@ Usage Example
5858
# Finally you can optionally specify a custom I2C address of the HT16k33 like:
5959
#matrix = matrix.Matrix16x8(i2c, address=0x70)
6060
61-
# Clear the matrix. Always call show after changing pixels to make the display
62-
# update visible!
61+
# Clear the matrix.
6362
matrix.fill(0)
64-
matrix.show()
6563
6664
# Set a pixel in the origin 0,0 position.
6765
matrix.pixel[0, 0] = 1
@@ -77,7 +75,6 @@ Usage Example
7775
# Set the blink rate
7876
matrix.blink_rate = 2
7977
80-
matrix.show()
8178
8279
Contributing
8380
============

adafruit_ht16k33/ht16k33.py

+7-1
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,13 @@
3939

4040

4141
class HT16K33:
42-
"""The base class for all displays. Contains common methods."""
42+
"""
43+
The base class for all displays. Contains common methods.
44+
45+
:param int address: The I2C addess of the HT16K33.
46+
:param bool auto_write: True if the display should immediately change when
47+
set. If False, `show` must be called explicitly.
48+
"""
4349
def __init__(self, i2c, address=0x70, auto_write=True):
4450
self.i2c_device = i2c_device.I2CDevice(i2c, address)
4551
self._temp = bytearray(1)

0 commit comments

Comments
 (0)