diff options
| author | mdroberts1243 <mdroberts1243@gmail.com> | 2020-09-28 19:40:47 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-09-28 19:40:47 -0400 |
| commit | b1e1237887945f6499b8884594b14e8bc4c5afbd (patch) | |
| tree | 3a5ef348163f769bbc97f7a15b94c99c24ecee0b /docs | |
| parent | db74f97e60e58c22e6ce73bd068d9279e3daee57 (diff) | |
| parent | 6bfcb01ee79d49f470a1a8ca5e693ba92fadf307 (diff) | |
Merge branch 'main' into New_quirk_for_SH1107
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/design_guide.rst | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/docs/design_guide.rst b/docs/design_guide.rst index 2d52e988b..cc2a3b296 100644 --- a/docs/design_guide.rst +++ b/docs/design_guide.rst @@ -485,6 +485,19 @@ 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 -------------------------------------------------------------------------------- |