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

Fix typos and grammar in design_guide

Browse Source
This commit is contained in:
Rohan Shah 2022-08-28 10:44:18 -04:00 committed by GitHub
parent 4b065c40d3
commit d476de1a04
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/design_guide.rst
View File

@ -141,7 +141,7 @@ statement will ensure hardware isn't enabled longer than needed.
Verify your device Verify your device
-------------------------------------------------------------------------------- --------------------------------------------------------------------------------
Whenever possible, make sure device you are talking to is the device you expect. Whenever possible, make sure the device you are talking to is the device you expect.
If not, raise a RuntimeError. Beware that I2C addresses can be identical on If not, raise a RuntimeError. Beware that I2C addresses can be identical on
different devices so read registers you know to make sure they match your different devices so read registers you know to make sure they match your
expectation. Validating this upfront will help catch mistakes. expectation. Validating this upfront will help catch mistakes.
@ -188,7 +188,7 @@ Design for compatibility with CPython
CircuitPython is aimed to be one's first experience with code. It will be the CircuitPython is aimed to be one's first experience with code. It will be the
first step into the world of hardware and software. To ease one's exploration first step into the world of hardware and software. To ease one's exploration
out from this first step, make sure that functionality shared with CPython shares out from this first step, make sure that the functionality shared with CPython shares
the same API. It doesn't need to be the full API it can be a subset. However, do the same API. It doesn't need to be the full API it can be a subset. However, do
not add non-CPython APIs to the same modules. Instead, use separate non-CPython not add non-CPython APIs to the same modules. Instead, use separate non-CPython
modules to add extra functionality. By distinguishing API boundaries at modules modules to add extra functionality. By distinguishing API boundaries at modules
@ -202,7 +202,7 @@ interchangeably with the CPython name. This is confusing. Instead, think up a
new name that is related to the extra functionality you are adding. new name that is related to the extra functionality you are adding.
For example, storage mounting and unmounting related functions were moved from For example, storage mounting and unmounting related functions were moved from
``uos`` into a new `storage` module. Terminal related functions were moved into ``uos`` into a new `storage` module. Terminal-related functions were moved into
`multiterminal`. These names better match their functionality and do not `multiterminal`. These names better match their functionality and do not
conflict with CPython names. Make sure to check that you don't conflict with conflict with CPython names. Make sure to check that you don't conflict with
CPython libraries too. That way we can port the API to CPython in the future. CPython libraries too. That way we can port the API to CPython in the future.
@ -213,7 +213,7 @@ Example
When adding extra functionality to CircuitPython to mimic what a normal When adding extra functionality to CircuitPython to mimic what a normal
operating system would do, either copy an existing CPython API (for example file 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, 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 mounting and unmounting drives is not a part of CPython so it should be done in a
module, such as a new ``storage`` module, 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 That way when someone moves the code to CPython they know what parts need to be
adapted. adapted.