Skip to content
This repository was archived by the owner on May 16, 2023. It is now read-only.

Commit df0b3b0

Browse files
committed
updated info docstring; docstring formatting
1 parent f034ac1 commit df0b3b0

File tree

1 file changed

+20
-4
lines changed

1 file changed

+20
-4
lines changed

adafruit_thermal_printer/thermal_printer.py

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,11 +27,26 @@
2727
receipt printers. Note that these printers have many different firmware
2828
versions and care must be taken to select the appropriate module inside this
2929
package for your firmware printer:
30-
- thermal_printer = The latest printers with firmware version 2.68+
31-
- thermal_printer_264 = Printers with firmware version 2.64 up to 2.68.
32-
- thermal_printer_legacy = Printers with firmware version before 2.64.
30+
31+
* thermal_printer = The latest printers with firmware version 2.68+
32+
* thermal_printer_264 = Printers with firmware version 2.64 up to 2.68.
33+
* thermal_printer_legacy = Printers with firmware version before 2.64.
3334
3435
* Author(s): Tony DiCola
36+
37+
Implementation Notes
38+
--------------------
39+
40+
**Hardware:**
41+
42+
* Mini `Thermal Receipt Printer
43+
<https://www.adafruit.com/product/597>`_ (Product ID: 597)
44+
45+
**Software and Dependencies:**
46+
47+
* Adafruit CircuitPython firmware for the ESP8622 and M0-based boards:
48+
https://github.com/adafruit/circuitpython/releases
49+
3550
"""
3651
import time
3752

@@ -319,7 +334,8 @@ def _print_bitmap(self, width, height, data):
319334
pre-process your images with a script, you CANNOT send .jpg/.bmp/etc.
320335
image formats. See this Processing sketch for preprocessing:
321336
https://github.com/adafruit/Adafruit-Thermal-Printer-Library/blob/master/processing/bitmapImageConvert/bitmapImageConvert.pde
322-
NOTE: This is currently not working because it appears the bytes are
337+
338+
.. note:: This is currently not working because it appears the bytes are
323339
sent too slowly and the printer gets confused with not enough data being
324340
sent to it in the expected time.
325341
"""

0 commit comments

Comments
 (0)