summaryrefslogtreecommitdiff
path: root/shared-bindings/storage
diff options
context:
space:
mode:
authorDan Halbert <halbert@halwitz.org>2018-04-10 12:08:41 -0400
committerDan Halbert <halbert@halwitz.org>2018-04-10 12:08:41 -0400
commit5f98953ed89f5e89b92f500788ae4ff0806886c8 (patch)
tree8211442c7e8aef157b6aee1a9aae20d9a09c8783 /shared-bindings/storage
parent1e9a27177c5d43ffcc3d02c94b0bc12eb4e7ae34 (diff)
esp8266 and nrf: raise NotImplementedError
Diffstat (limited to 'shared-bindings/storage')
-rw-r--r--shared-bindings/storage/__init__.c8
1 files changed, 5 insertions, 3 deletions
diff --git a/shared-bindings/storage/__init__.c b/shared-bindings/storage/__init__.c
index 2195d2242..ca9281a18 100644
--- a/shared-bindings/storage/__init__.c
+++ b/shared-bindings/storage/__init__.c
@@ -133,15 +133,17 @@ MP_DEFINE_CONST_FUN_OBJ_1(storage_getmount_obj, storage_getmount);
//| .. function:: erase_filesystem()
//|
-//| Erase and re-create the ``CIRCUITPY`` filesystem. Then call
-//| `microcontroller.reset()` to restart CircuitPython and have the
+//| Erase and re-create the ``CIRCUITPY`` filesystem.
+//|
+//| On boards that present USB-visible ``CIRCUITPY`` drive (e.g., SAMD21 and SAMD51),
+//| then call `microcontroller.reset()` to restart CircuitPython and have the
//| host computer remount CIRCUITPY.
//|
//| This function can be called from the REPL when ``CIRCUITPY``
//| has become corrupted.
//|
//| .. warning:: All the data on ``CIRCUITPY`` will be lost, and
-//| CircuitPython will restart.
+//| CircuitPython will restart on certain boards.
mp_obj_t storage_erase_filesystem(void) {
common_hal_storage_erase_filesystem();