diff options
| author | caternuson <caternuson@gmail.com> | 2020-09-28 13:28:38 -0700 |
|---|---|---|
| committer | caternuson <caternuson@gmail.com> | 2020-09-28 13:28:38 -0700 |
| commit | 4d4dbbcafe4330d9dcd16535605d8990960972b1 (patch) | |
| tree | a167a9b264fa99f837011278677efea4444e6ea7 | |
| parent | 8e4f08a109980e76df43cd95f8bca96422ae89ce (diff) | |
RST tweak
| -rw-r--r-- | docs/design_guide.rst | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/docs/design_guide.rst b/docs/design_guide.rst index 9ce8dc963..a00caf1d6 100644 --- a/docs/design_guide.rst +++ b/docs/design_guide.rst @@ -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 -------------------------------------------------------------------------------- |