summaryrefslogtreecommitdiff
path: root/shared-bindings/microcontroller/RunMode.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/microcontroller/RunMode.c
parentf572b723060382bbc9ca7a3edc88cb7c30fdcc30 (diff)
parenteec42d4cb53536a75e88f7f9321515bc6dcfeaa7 (diff)
Merge branch 'main' into patch-1
Diffstat (limited to 'shared-bindings/microcontroller/RunMode.c')
-rw-r--r--shared-bindings/microcontroller/RunMode.c36
1 files changed, 15 insertions, 21 deletions
diff --git a/shared-bindings/microcontroller/RunMode.c b/shared-bindings/microcontroller/RunMode.c
index 913242ad2..6db315d8d 100644
--- a/shared-bindings/microcontroller/RunMode.c
+++ b/shared-bindings/microcontroller/RunMode.c
@@ -26,34 +26,28 @@
#include "shared-bindings/microcontroller/RunMode.h"
-//| .. currentmodule:: microcontroller
+//| class RunMode:
+//| """run state of the microcontroller"""
//|
-//| :class:`RunMode` -- run state of the microcontroller
-//| =============================================================
+//| def __init__(self, ):
+//| """Enum-like class to define the run mode of the microcontroller and
+//| CircuitPython."""
//|
-//| .. class:: RunMode()
+//| NORMAL: Any = ...
+//| """Run CircuitPython as normal.
//|
-//| Enum-like class to define the run mode of the microcontroller and
-//| CircuitPython.
+//| :type microcontroller.RunMode:"""
//|
-//| .. attribute:: NORMAL
+//| SAFE_MODE: Any = ...
+//| """Run CircuitPython in safe mode. User code will not be run and the
+//| file system will be writeable over USB.
//|
-//| Run CircuitPython as normal.
+//| :type microcontroller.RunMode:"""
//|
-//| :type microcontroller.RunMode:
+//| BOOTLOADER: Any = ...
+//| """Run the bootloader.
//|
-//| .. attribute:: SAFE_MODE
-//|
-//| Run CircuitPython in safe mode. User code will not be run and the
-//| file system will be writeable over USB.
-//|
-//| :type microcontroller.RunMode:
-//|
-//| .. attribute:: BOOTLOADER
-//|
-//| Run the bootloader.
-//|
-//| :type microcontroller.RunMode:
+//| :type microcontroller.RunMode:"""
//|
const mp_obj_type_t mcu_runmode_type;