aboutsummaryrefslogtreecommitdiff
path: root/docs/design_guide.rst
diff options
context:
space:
mode:
authorScott Shawcroft <scott@chickadee.tech>2017-07-19 15:11:19 -0400
committerScott Shawcroft <scott@chickadee.tech>2017-07-19 15:15:23 -0400
commitf1e2afbea0244b04fb096862e132b181dba8c67f (patch)
treeec19b91288ec3bd9e3208f8d834e898b5df4c121 /docs/design_guide.rst
parent63ade7763536e0d94d22e7d67e3f78624da0bd4f (diff)
docs: Minor updates before 1.0.01.0.01.x
Diffstat (limited to 'docs/design_guide.rst')
-rw-r--r--docs/design_guide.rst15
1 files changed, 8 insertions, 7 deletions
diff --git a/docs/design_guide.rst b/docs/design_guide.rst
index efcc5fee8..1481caad7 100644
--- a/docs/design_guide.rst
+++ b/docs/design_guide.rst
@@ -132,7 +132,7 @@ When adding extra functionality to CircuitPython to mimic what a normal
operating system would do, either copy an existing CPython API (for example file
writing) or create a separate module to achieve what you want. For example,
mounting and unmount drives is not a part of CPython so it should be done in a
-module, such as a new ``filesystem``, that is only available in CircuitPython.
+module, such as a new ``storage`` module, that is only available in CircuitPython.
That way when someone moves the code to CPython they know what parts need to be
adapted.
@@ -235,12 +235,13 @@ Renders as:
Use BusDevice
--------------------------------------------------------------------------------
-BusDevice is an awesome foundational library that manages talking on a shared
-I2C or SPI device for you. The devices manage locking which ensures that a
-transfer is done as a single unit despite CircuitPython internals and, in the
-future, other Python threads. For I2C, the device also manages the device
-address. The SPI device, manages baudrate settings, chip select line and extra
-post-transaction clock cycles.
+[BusDevice](https://github.com/adafruit/Adafruit_CircuitPython_BusDevice) is an
+awesome foundational library that manages talking on a shared I2C or SPI device
+for you. The devices manage locking which ensures that a transfer is done as a
+single unit despite CircuitPython internals and, in the future, other Python
+threads. For I2C, the device also manages the device address. The SPI device,
+manages baudrate settings, chip select line and extra post-transaction clock
+cycles.
I2C Example
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^