Skip to content

Commit 6b3ae63

Browse files
committed
Improve time alarm doc
Fixes #7406
1 parent bb3a1c0 commit 6b3ae63

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

shared-bindings/alarm/time/TimeAlarm.c

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -51,11 +51,12 @@ mp_obj_t MP_WEAK rtc_get_time_source_time(void) {
5151
//| ``monotonic_time``, or when `time.time()` would equal ``epoch_time``.
5252
//| Only one of the two arguments can be given.
5353
//| The alarm is not active until it is passed to an
54-
//| `alarm`-enabling function, such as `alarm.light_sleep_until_alarms()` or
54+
//| `alarm`-enabling sleep function, such as `alarm.light_sleep_until_alarms()` or
5555
//| `alarm.exit_and_deep_sleep_until_alarms()`.
5656
//|
57-
//| If the given time is in the past when sleep occurs, the alarm will be triggered
58-
//| immediately.
57+
//| If the given time is already in the past, then an exception is raised.
58+
//| If the sleep happens after the given time, then it will wake immediately
59+
//| due to this time alarm.
5960
//| """
6061
//| ...
6162
STATIC mp_obj_t alarm_time_timealarm_make_new(const mp_obj_type_t *type,

0 commit comments

Comments
 (0)