djsundog/circuitpython
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Improve time alarm doc

Browse Source 
Fixes #7406
This commit is contained in:
Scott Shawcroft 2023-01-04 14:16:35 -05:00
parent bb3a1c0a2a
commit 6b3ae630a9
No known key found for this signature in database
GPG Key ID: 9349BC7E64B1921E
1 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
shared-bindings/alarm/time/TimeAlarm.c
View File

@ -51,11 +51,12 @@ mp_obj_t MP_WEAK rtc_get_time_source_time(void) {
//| ``monotonic_time``, or when `time.time()` would equal ``epoch_time``.
//| Only one of the two arguments can be given.
//| The alarm is not active until it is passed to an
//| `alarm`-enabling function, such as `alarm.light_sleep_until_alarms()` or
//| `alarm`-enabling sleep function, such as `alarm.light_sleep_until_alarms()` or
//| `alarm.exit_and_deep_sleep_until_alarms()`.
//|
//| If the given time is in the past when sleep occurs, the alarm will be triggered
//| immediately.
//| If the given time is already in the past, then an exception is raised.
//| If the sleep happens after the given time, then it will wake immediately
//| due to this time alarm.
//| """
//| ...
STATIC mp_obj_t alarm_time_timealarm_make_new(const mp_obj_type_t *type,