llimllib / limbo

A simple, clean, easy to modify Slack chatbot
MIT License
403 stars 160 forks source link

add documentation for `on_bot_message` #118

Closed topher200 closed 7 years ago

topher200 commented 7 years ago

The purpose of on_bot_message or how to use them is never explained in the documentation. In fact, that function signature never appears in the limbo codebase! (just in plugins). It makes it really hard to figure out what that function is for.

We might also want to add some documentation in limbo.py:run_hook around what the datastructure of hooks looks like and how we dynamically decide which hook to call.

llimllib commented 7 years ago

Definitely, I just wrote that quickly to fix an issue and should have documented it. Thanks!