From 45cd1dcac118f41e1da2c4a732a3888f41c5bb64 Mon Sep 17 00:00:00 2001 From: joeycastillo Date: Tue, 17 Jan 2023 11:02:56 -0600 Subject: clarify return value notes in template --- movement/template/template.c | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/movement/template/template.c b/movement/template/template.c index f0669d37..8259912b 100644 --- a/movement/template/template.c +++ b/movement/template/template.c @@ -81,8 +81,12 @@ bool <#watch_face_name#>_face_loop(movement_event_t event, movement_settings_t * return movement_default_loop_handler(event, settings); } - // return true if the watch can enter standby mode. If you are PWM'ing an LED or buzzing the buzzer here, - // you should return false since the PWM driver does not operate in standby mode. + // return true if the watch can enter standby mode. Generally speaking, you should always return true. + // Exceptions: + // * If you are displaying a color using the low-level watch_set_led_color function, you should return false. + // * If you are sounding the buzzer using the low-level watch_set_buzzer_on function, you should return false. + // Note that if you are driving the LED or buzzer using Movement functions like movement_illuminate_led or + // movement_play_alarm, you can still return true. This guidance only applies to the low-level watch_ functions. return true; } -- cgit v1.2.3