Skip to content

Commit 8e4f08a

Browse files
committed
add MP const info to Design Guide
1 parent 4d7b9cd commit 8e4f08a

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

docs/design_guide.rst

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -448,6 +448,19 @@ struct.pack
448448

449449
Use `struct.pack_into` instead of `struct.pack`.
450450

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

0 commit comments

Comments
 (0)