Note that nvm.ByteArray is available at microcontroller.nvm

Fixes #2766
2020-05-15 14:53:14 -07:00 · 2020-05-15 14:53:14 -07:00 · 7d167560af
parent 0d8bca92e2
commit 7d167560af
1 changed files with 5 additions and 1 deletions
--- 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) },