Skip to content

Commit 2d80f6b

Browse files
committed
Module_description_changes
1 parent 901e6ab commit 2d80f6b

File tree

1 file changed

+24
-1
lines changed

1 file changed

+24
-1
lines changed

docs/design_guide.rst

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -238,11 +238,34 @@ Module description
238238
After the license comment::
239239

240240
"""
241-
`<module name>` - <Short description>
241+
`<module name>`
242242
=================================================
243+
243244
<Longer description.>
245+
246+
* Author(s):
247+
248+
Implementation Notes
249+
--------------------
250+
251+
252+
**Hardware:**
253+
254+
* Adafruit `Device Description
255+
<hyperlink>`_ (Product ID: <Product Number>)
256+
257+
**Software and Dependencies:**
258+
259+
* Adafruit CircuitPython firmware for the supported boards:
260+
https://circuitpython.org/downloads
261+
* Adafruit's Bus Device library:
262+
https://github.com/adafruit/Adafruit_CircuitPython_BusDevice
263+
* Adafruit's Register library:
264+
https://github.com/adafruit/Adafruit_CircuitPython_Register
265+
244266
"""
245267

268+
246269
Class description
247270
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
248271

0 commit comments

Comments
 (0)