Skip to content

Commit a4f4eff

Browse files
authored
Update qrio documentation
1 parent 4827502 commit a4f4eff

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

shared-bindings/qrio/__init__.c

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,15 @@
3131
#include "py/obj.h"
3232
#include "py/enum.h"
3333

34-
//| """`qrio` module.
34+
//| """Low-level QR code decoding
3535
//|
36-
//| Provides the `QRDecoder` object."""
36+
//| Provides the `QRDecoder` object used for decoding QR codes. For more
37+
//| information about working with QR codes, see
38+
//| `this Learn guide <https://learn.adafruit.com/scan-qr-codes-with-circuitpython>`_.
39+
//|
40+
//| .. note:: This library only handles decoding QR codes. If you are looking
41+
//| to generate a QR code, use the
42+
//| `adafruit_miniqr library <https://github.com/adafruit/Adafruit_CircuitPython_miniQR>`_"""
3743
//|
3844

3945
STATIC const mp_rom_map_elem_t qrio_module_globals_table[] = {

0 commit comments

Comments
 (0)