Error in documentation

ejabberd module development documentation has an error in the ejabberd events and hooks topic: it defines roster_out_subscription event:
roster_out_subscription(Acc, User, Server, JID, SubscriptionType, Reason) -> bool()
but in reality its arguments are (User, Server, JID, SubscriptionType), and it doesn't return bool, but the only meaningful result is stop (as its code is called by ejabberd_hooks:run, not by ejabberd_hooks:run_fold).

Could someone please describe the meaning and correct usage of all those hooks that have no description in the official documentation, as the only other way is to look through the ejabberd source code trying to figure it out.

Thanks, I've fixed that and

Thanks, I've fixed that and the roster_in event too.

> Could someone please describe the meaning and correct usage of all those hooks that have no description in the official documentation

It would be nice to have them documented.

Having to document in a place different that the source code usually makes developers to forget to update the documentation. Related ticket: Document the ejabberd hooks using EDoc

Syndicate content