summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorThea Flowers <me@thea.codes>2020-05-15 14:53:14 -0700
committerThea Flowers <me@thea.codes>2020-05-15 14:53:14 -0700
commit7d167560af0e317edef2d4bc4385dfa0982f19f8 (patch)
tree9c3360f0b4b572ef29f4f96f7e686200c3e07a8a
parent0d8bca92e208e705150097d26db6a5390dc9eb9b (diff)
Note that nvm.ByteArray is available at microcontroller.nvm
Fixes #2766
-rw-r--r--shared-bindings/nvm/__init__.c6
1 files changed, 5 insertions, 1 deletions
diff --git a/shared-bindings/nvm/__init__.c b/shared-bindings/nvm/__init__.c
index 51c5bb278..cdcc285dc 100644
--- a/shared-bindings/nvm/__init__.c
+++ b/shared-bindings/nvm/__init__.c
@@ -34,7 +34,11 @@
//| """Non-volatile memory
//|
//| The `nvm` module allows you to store whatever raw bytes you wish in a
-//| reserved section non-volatile memory."""
+//| reserved section non-volatile memory.
+//|
+//| Note that this module can't be imported and used directly. The sole
+//| instance of :class:`ByteArray` is available at
+//| :attr:`microcontroller.nvm`."""
//|
STATIC const mp_rom_map_elem_t nvm_module_globals_table[] = {
{ MP_ROM_QSTR(MP_QSTR___name__), MP_ROM_QSTR(MP_QSTR_nvm) },