From 5a1223fea8f165114da877337ec9aa6fb69bfa95 Mon Sep 17 00:00:00 2001 From: Alec Delaney <89490472+tekktrik@users.noreply.github.com> Date: Mon, 12 Sep 2022 20:07:37 -0400 Subject: [PATCH 1/5] Add info for rotaryio --- shared-bindings/rotaryio/__init__.c | 3 +++ 1 file changed, 3 insertions(+) diff --git a/shared-bindings/rotaryio/__init__.c b/shared-bindings/rotaryio/__init__.c index 43a884e9a1..fbfa9afaa2 100644 --- a/shared-bindings/rotaryio/__init__.c +++ b/shared-bindings/rotaryio/__init__.c @@ -39,6 +39,9 @@ //| `Wikipedia's Rotary Encoder page `_ for more //| background. //| +//| For more information on working with rotary encoders using this library, see +//| `this Learn Guide `_. +//| //| All classes change hardware state and should be deinitialized when they //| are no longer needed if the program continues after use. To do so, either //| call :py:meth:`!deinit` or use a context manager. See From fcdb988fa11443199807a913da1e692bbd2ba737 Mon Sep 17 00:00:00 2001 From: Alec Delaney <89490472+tekktrik@users.noreply.github.com> Date: Mon, 12 Sep 2022 20:36:51 -0400 Subject: [PATCH 2/5] Add information for audioio --- shared-bindings/audioio/__init__.c | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/shared-bindings/audioio/__init__.c b/shared-bindings/audioio/__init__.c index 9f8411f484..f03ffd612a 100644 --- a/shared-bindings/audioio/__init__.c +++ b/shared-bindings/audioio/__init__.c @@ -42,6 +42,10 @@ //| call :py:meth:`!deinit` or use a context manager. See //| :ref:`lifetime-and-contextmanagers` for more info. //| +//| For more information on working with this module, refer to the +//| `CircuitPython Essentials Learn Guide +//| `_. +//| //| Since CircuitPython 5, `RawSample` and `WaveFile` are moved //| to :mod:`audiocore`, and `Mixer` is moved to :mod:`audiomixer`. //| From a7c7d1428a4e57e36de4d6b0a6d653073cbaa16a Mon Sep 17 00:00:00 2001 From: Alec Delaney <89490472+tekktrik@users.noreply.github.com> Date: Mon, 12 Sep 2022 20:46:29 -0400 Subject: [PATCH 3/5] Add information for countio --- shared-bindings/countio/__init__.c | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/shared-bindings/countio/__init__.c b/shared-bindings/countio/__init__.c index d72ed9fd25..307966c202 100644 --- a/shared-bindings/countio/__init__.c +++ b/shared-bindings/countio/__init__.c @@ -13,6 +13,10 @@ //| //| The `countio` module contains logic to read and count edge transistions //| +//| For more information on the applications of counting edges, see +//| `this Learn Guide on sequential circuits +//| `_. +//| //| All classes change hardware state and should be deinitialized when they //| are no longer needed if the program continues after use. To do so, either //| call :py:meth:`!deinit` or use a context manager. See From b90a3160d4a872a003c98515835830064208730d Mon Sep 17 00:00:00 2001 From: Alec Delaney <89490472+tekktrik@users.noreply.github.com> Date: Mon, 12 Sep 2022 21:09:07 -0400 Subject: [PATCH 4/5] Add information on canio --- shared-bindings/canio/__init__.c | 3 +++ 1 file changed, 3 insertions(+) diff --git a/shared-bindings/canio/__init__.c b/shared-bindings/canio/__init__.c index ef1b90df97..ecef7ebde6 100644 --- a/shared-bindings/canio/__init__.c +++ b/shared-bindings/canio/__init__.c @@ -54,6 +54,9 @@ //| Other implementations of the CAN device may exist (for instance, attached //| via an SPI bus). If so their constructor arguments may differ, but //| otherwise we encourage implementors to follow the API that the core uses. +//| +//| For more information on working with this module, refer to +//| `this Learn Guide on using it `_. //| """ //| From 129e38096ecfe82173b049d68b72cbba291f2460 Mon Sep 17 00:00:00 2001 From: Alec Delaney <89490472+tekktrik@users.noreply.github.com> Date: Mon, 12 Sep 2022 21:15:07 -0400 Subject: [PATCH 5/5] Add information to aesio --- shared-bindings/aesio/__init__.c | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/shared-bindings/aesio/__init__.c b/shared-bindings/aesio/__init__.c index 716d20393e..f3e1d7dd17 100644 --- a/shared-bindings/aesio/__init__.c +++ b/shared-bindings/aesio/__init__.c @@ -34,7 +34,11 @@ //| """AES encryption routines //| //| The `AES` module contains classes used to implement encryption -//| and decryption. It aims to be low overhead in terms of memory.""" +//| and decryption. It aims to be low overhead in terms of memory. +//| +//| For more information on AES, refer to `the Wikipedia entry +//| `_. +//| """ STATIC const mp_obj_tuple_t mp_aes_key_size_obj = {