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

Merge pull request #3481 from caternuson/iss3480_docupdate

Browse Source 
Add MP const info to Design Guide
This commit is contained in:
Scott Shawcroft 2020-09-28 14:30:28 -07:00 committed by GitHub
commit 785f2beed0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
docs/design_guide.rst
View File

@ -485,6 +485,19 @@ struct.pack
Use `struct.pack_into` instead of `struct.pack`. Use `struct.pack_into` instead of `struct.pack`.
Use of MicroPython ``const()``
--------------------------------------------------------------------------------
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:
- 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``.
Sensor properties and units Sensor properties and units
-------------------------------------------------------------------------------- --------------------------------------------------------------------------------