summaryrefslogtreecommitdiff
path: root/shared-bindings/nvm/ByteArray.c
diff options
context:
space:
mode:
authorScott Shawcroft <scott@adafruit.com>2020-07-02 13:56:09 -0700
committerGitHub <noreply@github.com>2020-07-02 13:56:09 -0700
commitc33542f978cc61f0466ff60ea769e3067baca95f (patch)
tree071e8f8a86971f7e947053c3b4fb2ff7da95d223 /shared-bindings/nvm/ByteArray.c
parentf572b723060382bbc9ca7a3edc88cb7c30fdcc30 (diff)
parenteec42d4cb53536a75e88f7f9321515bc6dcfeaa7 (diff)
Merge branch 'main' into patch-1
Diffstat (limited to 'shared-bindings/nvm/ByteArray.c')
-rw-r--r--shared-bindings/nvm/ByteArray.c30
1 files changed, 14 insertions, 16 deletions
diff --git a/shared-bindings/nvm/ByteArray.c b/shared-bindings/nvm/ByteArray.c
index 31bedeacc..06d7d4c95 100644
--- a/shared-bindings/nvm/ByteArray.c
+++ b/shared-bindings/nvm/ByteArray.c
@@ -31,29 +31,27 @@
#include "shared-bindings/nvm/ByteArray.h"
#include "supervisor/shared/translate.h"
-//| .. currentmodule:: nvm
+//| class ByteArray:
+//| r"""Presents a stretch of non-volatile memory as a bytearray.
//|
-//| :class:`ByteArray` -- Presents a stretch of non-volatile memory as a bytearray.
-//| ================================================================================
+//| Non-volatile memory is available as a byte array that persists over reloads
+//| and power cycles. Each assignment causes an erase and write cycle so its recommended to assign
+//| all values to change at once.
//|
-//| Non-volatile memory is available as a byte array that persists over reloads
-//| and power cycles. Each assignment causes an erase and write cycle so its recommended to assign
-//| all values to change at once.
+//| Usage::
//|
-//| Usage::
-//|
-//| import microcontroller
-//| microcontroller.nvm[0:3] = b"\xcc\x10\x00"
+//| import microcontroller
+//| microcontroller.nvm[0:3] = b\"\xcc\x10\x00\""""
//|
-//| .. class:: ByteArray()
-//|
-//| Not currently dynamically supported. Access the sole instance through `microcontroller.nvm`.
+//| def __init__(self, ):
+//| """Not currently dynamically supported. Access the sole instance through `microcontroller.nvm`."""
+//| ...
//|
-//| .. method:: __len__()
-//|
-//| Return the length. This is used by (`len`)
+//| def __len__(self, ) -> Any:
+//| """Return the length. This is used by (`len`)"""
+//| ...
//|
STATIC mp_obj_t nvm_bytearray_unary_op(mp_unary_op_t op, mp_obj_t self_in) {
nvm_bytearray_obj_t *self = MP_OBJ_TO_PTR(self_in);