djsundog/circuitpython
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #6900 from tekktrik/doc/add-more-documentation

Browse Source 
Doc/add more documentation
This commit is contained in:
Dan Halbert 2022-09-13 14:29:19 -04:00 committed by GitHub
commit 792943f6eb
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 19 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
shared-bindings/aesio/__init__.c
View File

@ -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
//| <https://en.wikipedia.org/wiki/Advanced_Encryption_Standard>`_.
//| """
STATIC const mp_obj_tuple_t mp_aes_key_size_obj = {

4
shared-bindings/audioio/__init__.c
View File

@ -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
//| <https://learn.adafruit.com/circuitpython-essentials/circuitpython-audio-out>`_.
//|
//| Since CircuitPython 5, `RawSample` and `WaveFile` are moved
//| to :mod:`audiocore`, and `Mixer` is moved to :mod:`audiomixer`.
//|

3
shared-bindings/canio/__init__.c
View File

@ -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 <https://learn.adafruit.com/using-canio-circuitpython>`_.
//| """
//|

4
shared-bindings/countio/__init__.c
View File

@ -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
//| <https://learn.adafruit.com/digital-circuits-4-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

3
shared-bindings/rotaryio/__init__.c
View File

@ -39,6 +39,9 @@
//| `Wikipedia's Rotary Encoder page <https://en.wikipedia.org/wiki/Rotary_encoder>`_ for more
//| background.
//|
//| For more information on working with rotary encoders using this library, see
//| `this Learn Guide <https://learn.adafruit.com/rotary-encoder>`_.
//|
//| 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