Skip to content

Commit 3b5d503

Browse files
committed
updated info docstring; docstring formatting
1 parent 161210e commit 3b5d503

File tree

1 file changed

+19
-7
lines changed

1 file changed

+19
-7
lines changed

adafruit_max9744.py

Lines changed: 19 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -20,13 +20,26 @@
2020
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
2121
# THE SOFTWARE.
2222
"""
23-
`Adafruit_MAX9744`
23+
`adafruit_max9744`
2424
====================================================
2525
2626
CircuitPython module for the MAX9744 20W class D amplifier. See
2727
examples/simpletest.py for a demo of the usage.
2828
2929
* Author(s): Tony DiCola
30+
31+
Implementation Notes
32+
--------------------
33+
34+
**Hardware:**
35+
36+
* Adafruit `MAX9744 Stereo 20W Class D Audio Amplifier
37+
<https://www.adafruit.com/product/1752>`_ (Product ID: 1752)
38+
39+
**Software and Dependencies:**
40+
41+
* Adafruit CircuitPython firmware for the ESP8622 and M0-based boards:
42+
https://github.com/adafruit/circuitpython/releases
3043
"""
3144
from micropython import const
3245

@@ -46,13 +59,12 @@
4659

4760

4861
class MAX9744:
49-
"""MAX9744 20 watt class D amplifier. Construct this by passing the
50-
following parameters:
51-
- i2c: The I2C bus for the device.
62+
"""MAX9744 20 watt class D amplifier.
63+
64+
:param i2c: The I2C bus for the device.
5265
53-
Optionally specify:
54-
- address: The address of the device if it has been overridden from the
55-
default with the AD1, AD2 pins.
66+
:param address: (Optional) The address of the device if it has been overridden from the
67+
default with the AD1, AD2 pins.
5668
"""
5769

5870
# Global buffer for writing data. This saves memory use and prevents

0 commit comments

Comments
 (0)