Add description of alarm modules

4 files changed, 16 insertions, 0 deletions

diff --git a/shared-bindings/alarm/__init__.c b/shared-bindings/alarm/__init__.c
index 37462d88c..88c4bc887 100644
--- a/shared-bindings/alarm/__init__.c
+++ b/shared-bindings/alarm/__init__.c
@@ -1,5 +1,9 @@
 #include "shared-bindings/alarm/__init__.h"
 
+//| """alarm module
+//|
+//| The `alarm` module implements deep sleep."""
+
 STATIC mp_obj_t alarm_get_wake_alarm(void) {
     return common_hal_alarm_get_wake_alarm();
 }
diff --git a/shared-bindings/alarm_io/__init__.c b/shared-bindings/alarm_io/__init__.c
index dbe467176..4e42f9a2e 100644
--- a/shared-bindings/alarm_io/__init__.c
+++ b/shared-bindings/alarm_io/__init__.c
@@ -3,6 +3,10 @@
 #include "shared-bindings/alarm_io/__init__.h"
 #include "shared-bindings/microcontroller/Pin.h"
 
+//| """alarm_io module
+//|
+//| The `alarm_io` module implements deep sleep."""
+
 STATIC mp_obj_t alarm_io_pin_state(size_t n_args, const mp_obj_t *pos_args, mp_map_t *kw_args) {
     enum { ARG_level, ARG_pull };
     static const mp_arg_t allowed_args[] = {
diff --git a/shared-bindings/alarm_time/__init__.c b/shared-bindings/alarm_time/__init__.c
index 218ac6857..1707f7488 100644
--- a/shared-bindings/alarm_time/__init__.c
+++ b/shared-bindings/alarm_time/__init__.c
@@ -1,6 +1,10 @@
 #include "py/obj.h"
 #include "shared-bindings/alarm_time/__init__.h"
 
+//| """alarm_time module
+//|
+//| The `alarm_time` module implements deep sleep."""
+
 STATIC mp_obj_t alarm_time_duration(mp_obj_t seconds_o) {
     #if MICROPY_PY_BUILTINS_FLOAT
     mp_float_t seconds = mp_obj_get_float(seconds_o);
diff --git a/shared-bindings/alarm_touch/__init__.c b/shared-bindings/alarm_touch/__init__.c
index e36fa73cb..5f5a156d8 100644
--- a/shared-bindings/alarm_touch/__init__.c
+++ b/shared-bindings/alarm_touch/__init__.c
@@ -1,6 +1,10 @@
 #include "py/obj.h"
 #include "shared-bindings/alarm_touch/__init__.h"
 
+//| """alarm_touch module
+//|
+//| The `alarm_touch` module implements deep sleep."""
+
 STATIC mp_obj_t alarm_touch_disable(void) {
     common_hal_alarm_touch_disable();
     return mp_const_none;