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

RST tweak

Browse Source
This commit is contained in:
caternuson 2020-09-28 13:28:38 -07:00
parent 8e4f08a109
commit 4d4dbbcafe
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/design_guide.rst
View File

@ -448,18 +448,18 @@ struct.pack
Use `struct.pack_into` instead of `struct.pack`.
Use of MicroPython `const()`
Use of MicroPython ``const()``
--------------------------------------------------------------------------------
The MicroPython `const()` feature, as discussed in `this forum post
The MicroPython ``const()`` feature, as discussed in `this forum post
<https://forum.micropython.org/viewtopic.php?t=450>`_, and in `this issue thread
<https://github.com/micropython/micropython/issues/573>`_, provides some
optimizations that can be useful on smaller, memory constrained devices. However,
when using `const()`, keep in mind these general guide lines:
when using ``const()``, keep in mind these general guide lines:
- Always use via an import, ex: `from micropython import const`
- Always use via an import, ex: ``from micropython import const``
- Limit use to global (module level) variables only.
- If user will not need access to variable, prefix name with a leading
underscore, ex: `_SOME_CONST`.
underscore, ex: ``_SOME_CONST``.
Sensor properties and units
--------------------------------------------------------------------------------