Rename timer `Setup` function to `Schedule`
This patch was motivated by my desire to fix a typo in the function
name. The noun "setup" is 1 word. The verb "set up" is 2 words. All
other member functions are verbs, so this one should be a verb too.
That means that the function should be called `SetUp`. During the
discussion that resulted from the rename, James Kuszmaul pointed out
that "setting up" a timer can be confusing. It implies that you can
only "set up" a timer once. But the intent is to let users set up
timers as many times as they like. So we decided on renaming the
function to `Schedule`. That conveys the purpose and intent better.
I took this opportunity to fix some other typos involving the verb
"set up".
Signed-off-by: Philipp Schrader <philipp.schrader@gmail.com>
Change-Id: I2f557d1f946960af82711f248820d5e2d385a5d3
diff --git a/y2022/vision/gpio.h b/y2022/vision/gpio.h
index bc9aa8a..6ed7328 100644
--- a/y2022/vision/gpio.h
+++ b/y2022/vision/gpio.h
@@ -332,13 +332,13 @@
// If the leds are currently off, turn them on for duty_cycle % of
// period If they are currently on, turn them off for 1 -
// duty_cycle % of period
- pwm_timer_->Setup(
+ pwm_timer_->Schedule(
event_loop_->monotonic_now() +
std::chrono::microseconds(leds_on_ ? (period_us - on_time_us)
: on_time_us));
leds_on_ = !leds_on_;
})) {
- pwm_timer_->Setup(event_loop_->monotonic_now());
+ pwm_timer_->Schedule(event_loop_->monotonic_now());
};
void set_duty_cycle(double duty_cycle) { duty_cycle_ = duty_cycle; }