Skip to content

Commit 792943f

Browse files
authored
Merge pull request #6900 from tekktrik/doc/add-more-documentation
Doc/add more documentation
2 parents 5a053f9 + 129e380 commit 792943f

File tree

5 files changed

+19
-1
lines changed

5 files changed

+19
-1
lines changed

shared-bindings/aesio/__init__.c

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,11 @@
3434
//| """AES encryption routines
3535
//|
3636
//| The `AES` module contains classes used to implement encryption
37-
//| and decryption. It aims to be low overhead in terms of memory."""
37+
//| and decryption. It aims to be low overhead in terms of memory.
38+
//|
39+
//| For more information on AES, refer to `the Wikipedia entry
40+
//| <https://en.wikipedia.org/wiki/Advanced_Encryption_Standard>`_.
41+
//| """
3842

3943

4044
STATIC const mp_obj_tuple_t mp_aes_key_size_obj = {

shared-bindings/audioio/__init__.c

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,10 @@
4242
//| call :py:meth:`!deinit` or use a context manager. See
4343
//| :ref:`lifetime-and-contextmanagers` for more info.
4444
//|
45+
//| For more information on working with this module, refer to the
46+
//| `CircuitPython Essentials Learn Guide
47+
//| <https://learn.adafruit.com/circuitpython-essentials/circuitpython-audio-out>`_.
48+
//|
4549
//| Since CircuitPython 5, `RawSample` and `WaveFile` are moved
4650
//| to :mod:`audiocore`, and `Mixer` is moved to :mod:`audiomixer`.
4751
//|

shared-bindings/canio/__init__.c

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,9 @@
5454
//| Other implementations of the CAN device may exist (for instance, attached
5555
//| via an SPI bus). If so their constructor arguments may differ, but
5656
//| otherwise we encourage implementors to follow the API that the core uses.
57+
//|
58+
//| For more information on working with this module, refer to
59+
//| `this Learn Guide on using it <https://learn.adafruit.com/using-canio-circuitpython>`_.
5760
//| """
5861
//|
5962

shared-bindings/countio/__init__.c

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,10 @@
1313
//|
1414
//| The `countio` module contains logic to read and count edge transistions
1515
//|
16+
//| For more information on the applications of counting edges, see
17+
//| `this Learn Guide on sequential circuits
18+
//| <https://learn.adafruit.com/digital-circuits-4-sequential-circuits>`_.
19+
//|
1620
//| All classes change hardware state and should be deinitialized when they
1721
//| are no longer needed if the program continues after use. To do so, either
1822
//| call :py:meth:`!deinit` or use a context manager. See

shared-bindings/rotaryio/__init__.c

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,9 @@
3939
//| `Wikipedia's Rotary Encoder page <https://en.wikipedia.org/wiki/Rotary_encoder>`_ for more
4040
//| background.
4141
//|
42+
//| For more information on working with rotary encoders using this library, see
43+
//| `this Learn Guide <https://learn.adafruit.com/rotary-encoder>`_.
44+
//|
4245
//| All classes change hardware state and should be deinitialized when they
4346
//| are no longer needed if the program continues after use. To do so, either
4447
//| call :py:meth:`!deinit` or use a context manager. See

0 commit comments

Comments
 (0)