sopel-irc / sopel

:robot::speech_balloon: An easy-to-use and highly extensible IRC Bot framework. Formerly Willie.
https://sopel.chat
Other
949 stars 403 forks source link

docs: add advanced tip about scheduling function calls #2617

Open dgw opened 1 month ago

dgw commented 1 month ago

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

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.