How to do this was discussed fairly well in #1222 a while ago, and I just cribbed an example from there.
I also found an apparently obsolete note about using sched with @plugin.rate and friends while poking around the topic of scheduled callables, because I tested what it said and found that the caveat no longer applies (see #825).
[x] I can and do license this contribution under the EFLv2
[x] No issues are reported by make qa (runs make lint and make test)
[x] I have tested the functionality of the things this change touches
Notes
Along the way I also briefly considered giving the bot a schedule instance that it provides to plugins, but I'm not ready to commit to that kind of API addition yet. Putting this into the tips & tricks section is better than pointing to a random issue comment on the occasions when "how do I schedule a function at a specific time?" comes up, and it doesn't preclude API additions at a later time if we come up with a sane decorator interface for it.
How to do this was discussed fairly well in #1222 a while ago, and I just cribbed an example from there.
I also found an apparently obsolete note about using
sched
with@plugin.rate
and friends while poking around the topic of scheduled callables, because I tested what it said and found that the caveat no longer applies (see #825).Checklist
make qa
(runsmake lint
andmake test
)Notes
Along the way I also briefly considered giving the
bot
aschedule
instance that it provides to plugins, but I'm not ready to commit to that kind of API addition yet. Putting this into the tips & tricks section is better than pointing to a random issue comment on the occasions when "how do I schedule a function at a specific time?" comes up, and it doesn't preclude API additions at a later time if we come up with a sane decorator interface for it.